org.sakaiproject.coursemanagement.impl.provider

Class SectionRoleResolver

java.lang.Object

org.sakaiproject.coursemanagement.impl.provider.BaseRoleResolver

org.sakaiproject.coursemanagement.impl.provider.SectionRoleResolver

All Implemented Interfaces:

RoleResolver

public class SectionRoleResolver
extends BaseRoleResolver

Resolves users roles in sections.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENROLLMENT_STATUS_TO_SITE_ROLE
protected Map<String,String>	enrollmentStatusRoleMap The Sakai roles to use for official enrollments in EnrollmentSets,keyed on the enrollment status
static String	OFFICIAL_INSTRUCTOR_TO_SITE_ROLE
protected String	officialInstructorRole The Sakai role to use for official instructors of EnrollmentSets
static String	SECTION_ROLE_TO_SITE_ROLE

Fields inherited from class org.sakaiproject.coursemanagement.impl.provider.BaseRoleResolver

configuration, roleMap

Constructor Summary

Constructors

Constructor and Description
SectionRoleResolver()

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) Since a user may be both enrolled in a mapped EnrollmentSet and have a Membership role in a mapped Section, the following order of precedence is applied: Official Instructor, Enrollment, membership
void	init() Internal configuration.
void	setEnrollmentStatusRoleMap(Map<String,String> enrollmentStatusRoleMap)
void	setOfficialInstructorRole(String officialInstructorRole)

Methods inherited from class org.sakaiproject.coursemanagement.impl.provider.BaseRoleResolver

convertRole, setConfiguration, setRoleMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFFICIAL_INSTRUCTOR_TO_SITE_ROLE

public static final String OFFICIAL_INSTRUCTOR_TO_SITE_ROLE

See Also:

Constant Field Values

ENROLLMENT_STATUS_TO_SITE_ROLE

public static final String ENROLLMENT_STATUS_TO_SITE_ROLE

See Also:

Constant Field Values

SECTION_ROLE_TO_SITE_ROLE

public static final String SECTION_ROLE_TO_SITE_ROLE

See Also:

Constant Field Values

officialInstructorRole

protected String officialInstructorRole

The Sakai role to use for official instructors of EnrollmentSets

enrollmentStatusRoleMap

protected Map<String,String> enrollmentStatusRoleMap

The Sakai roles to use for official enrollments in EnrollmentSets,keyed on the enrollment status

Constructor Detail

SectionRoleResolver

public SectionRoleResolver()

Method Detail

init

public void init()

Internal configuration.

getUserRoles

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

Since a user may be both enrolled in a mapped EnrollmentSet and have a Membership role in a mapped Section, the following order of precedence is applied: Official Instructor, Enrollment, membership

Parameters:

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

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

Returns:

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

getGroupRoles

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

Description copied from interface: RoleResolver

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

Parameters:

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

userEid - The user's enterprise ID

Returns:

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

setOfficialInstructorRole

public void setOfficialInstructorRole(String officialInstructorRole)

setEnrollmentStatusRoleMap

public void setEnrollmentStatusRoleMap(Map<String,String> enrollmentStatusRoleMap)