blackboard.cms.filesystem.security
Class CourseRolePrincipal

java.lang.Object
  blackboard.cms.filesystem.security.CSPrincipal
      blackboard.cms.filesystem.security.CourseRolePrincipal

public class CourseRolePrincipal

extends CSPrincipal

Object used to manage information with a specific Course and Role

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

static java.lang.String	calculatePrincipalID(blackboard.data.course.Course course, blackboard.data.course.CourseMembership.Role role) Returns a string that represents the Principal ID
static CourseRolePrincipal	createInstance(blackboard.data.course.Course course, blackboard.data.course.CourseMembership.Role role) Create an instance of CourseRolePrincipal
blackboard.data.course.Course	getCourse() Returns the Course associated with object
blackboard.data.course.CourseMembership.Role	getRole() Returns the CourseMembership.Role associated with object

Methods inherited from class blackboard.cms.filesystem.security.CSPrincipal

getDisplayName, getPrincipalID

Methods inherited from class java.lang.Object

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

Method Detail

getCourse

public blackboard.data.course.Course getCourse()

Returns the Course associated with object

Returns:

a Course

getRole

public blackboard.data.course.CourseMembership.Role getRole()

Returns the CourseMembership.Role associated with object

Returns:

a CourseMembership.Role

createInstance

public static CourseRolePrincipal createInstance(blackboard.data.course.Course course,
                                                 blackboard.data.course.CourseMembership.Role role)

Create an instance of CourseRolePrincipal

Parameters:

course - a Course

role - a CourseMembership.Role

Returns:

a CourseRolePrincipal

calculatePrincipalID

public static java.lang.String calculatePrincipalID(blackboard.data.course.Course course,
                                                    blackboard.data.course.CourseMembership.Role role)

Returns a string that represents the Principal ID

Parameters:

course - a Course

role - a CourseMembership.Role

Returns:

a String that represents the PrincipalID for the Course and CourseMembership.Role