blackboard.cms.filesystem.security
Class CourseRolePrincipal

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

public class CourseRolePrincipal
extends CSPrincipal

The CourseRolePrincipal class provides a representation of a Principal, an entity to which filesystem access permissions may be granted , in terms of its associated relationship to a CourseMembership.Role and a Course within the Blackboard Content System.

Since:
Bb CS 1.2

Method Summary
static java.lang.String calculatePrincipalID(Course course, CourseMembership.Role role)
          Returns a string that represents the Principal ID.
static CourseRolePrincipal createInstance(Course course, CourseMembership.Role role)
          Creates an instance of CourseRolePrincipal from Course and CourseMembership.Role attributes.
 Course getCourse()
          Returns the Course associated with the Principal.
 CourseMembership.Role getRole()
          Returns the CourseMembership.Role associated with the Principal.
 
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 Course getCourse()
Returns the Course associated with the Principal.

Returns:
a Course representing the associated Course.

getRole

public CourseMembership.Role getRole()
Returns the CourseMembership.Role associated with the Principal.

Returns:
a CourseMembership.Role representing the associated CourseMembership.Role.

createInstance

public static CourseRolePrincipal createInstance(Course course,
                                                 CourseMembership.Role role)
Creates an instance of CourseRolePrincipal from Course and CourseMembership.Role attributes.

Parameters:
course - a Course
role - a CourseMembership.Role
Returns:
a CourseRolePrincipal

calculatePrincipalID

public static java.lang.String calculatePrincipalID(Course course,
                                                    CourseMembership.Role role)
Returns a string that represents the Principal ID. Every principal must be uniquely identified by a Principal ID.

Parameters:
course - a Course
role - a CourseMembership.Role
Returns:
a String that represents the PrincipalID for the Course and CourseMembership.Role


Copyright © 2012 Blackboard, Inc. All Rights Reserved.