org.sakaiproject.coursemanagement.impl.provider

Interface RoleResolver

All Known Implementing Classes:

BaseRoleResolver, CourseOfferingRoleResolver, CourseSetRoleResolver, SectionRoleResolver

public interface RoleResolver

Resolves users roles in CM objects.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getGroupRoles(CourseManagementService cmService, String userEid) Gets a single user's roles in all sections with which s/he is associated.
Map<String,String>	getUserRoles(CourseManagementService cmService, Section section) Gets users roles in a CM object.

Method Detail

getUserRoles

Map<String,String> getUserRoles(CourseManagementService cmService,
                                Section section)

Gets users roles in a CM object. A RoleResolver implementation will typically use the cmService to look "up" from the section in the CM hierarchy to find the object it's interested in, then find any membership roles associated with the user.

Parameters:

section - The section from which to start searching "up" the hierarchy, if necessary

cmService - The CM service impl. We pass this in rather than injecting it into every RoleResolver

Returns:

The user's role, or null if the user has no role in this CM object

getGroupRoles

Map<String,String> getGroupRoles(CourseManagementService cmService,
                                 String userEid)

Gets a single user's roles in all sections with which s/he is associated.

Parameters:

userEid - The user's enterprise ID

cmService - The CM service impl. We pass this in rather than injecting it into every RoleResolver

Returns:

The user's roles, or null if the user has no role in this CM object