blackboard.cms.filesystem.security
Class CoursePrincipal

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

public class CoursePrincipal
extends CSPrincipal

Object used to represent a Content System principal for the specified course. It is used only to identify users with respect to their security privileges as part of the security framework.

Since:

Bb CS 1.2

Version:

$Revision: #1 $

Method Summary

static java.lang.String	calculatePrincipalID(blackboard.data.course.Course course) Returns a string that represents the Course Principal ID
static CoursePrincipal	createInstance(blackboard.data.course.Course course) Create an instance of CoursePrincipal
blackboard.data.course.Course	getCourse() Returns the Course 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

createInstance

public static CoursePrincipal createInstance(blackboard.data.course.Course course)

Create an instance of CoursePrincipal

Parameters:

course - a Course

Returns:

a CoursePrincipal

calculatePrincipalID

public static java.lang.String calculatePrincipalID(blackboard.data.course.Course course)

Returns a string that represents the Course Principal ID

Parameters:

course - a Course

Returns:

a String that represents the PrincipalID for the Course