blackboard.cms.filesystem.security
Class CSPrincipal

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

Direct Known Subclasses:

CourseGroupPrincipal, CoursePrincipal, CourseRolePrincipal, PortalRolePrincipal, PortfolioPrincipal, SystemRolePrincipal, UserPrincipal

public abstract class CSPrincipal

extends java.lang.Object

The Principal interface defines the concept of a principal, encompassing any entity to which filesystem access permissions may be granted. Every principal must be uniquely identified by a principal ID. All Content System user and group objects extend this object.

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

java.lang.String	getDisplayName() Returns the display name for this principal.
java.lang.String	getPrincipalID() Returns the PrincipalID (unique identifier) for this entity.

Methods inherited from class java.lang.Object

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

Method Detail

getPrincipalID

public java.lang.String getPrincipalID()
                                throws CSFileSystemException

Returns the PrincipalID (unique identifier) for this entity.

Returns:

a String representing the PrincipalID

Throws:

CSFileSystemException

getDisplayName

public java.lang.String getDisplayName()
                                throws CSFileSystemException

Returns the display name for this principal.

Returns:

a String representing the display name

Throws:

CSFileSystemException