blackboard.cms.filesystem.security
Class SystemRolePrincipal

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

public class SystemRolePrincipal
extends CSPrincipal

Object used to represent a CSPrincipal for a given User.SystemRole

Since:

Bb CS 1.2

Version:

$Revision: #1 $

Constructor Summary

protected

SystemRolePrincipal(BlackboardSystemRoleGroup blackboardSystemRoleGroup)

Method Summary

static java.lang.String	calculatePrincipalID(blackboard.data.user.User.SystemRole role) Returns a string that represents the System Role Principal ID
static SystemRolePrincipal	createInstance(blackboard.data.user.User.SystemRole role) Create an instance of SystemRolePrincipal
blackboard.data.user.User.SystemRole	getSystemRole() Returns the User.SystemRole associated with this SystemRolePrincipal

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

Constructor Detail

SystemRolePrincipal

protected SystemRolePrincipal(BlackboardSystemRoleGroup blackboardSystemRoleGroup)

Method Detail

getSystemRole

public blackboard.data.user.User.SystemRole getSystemRole()

Returns the User.SystemRole associated with this SystemRolePrincipal

Returns:

a User.SystemRole

createInstance

public static SystemRolePrincipal createInstance(blackboard.data.user.User.SystemRole role)

Create an instance of SystemRolePrincipal

Parameters:

role - a User.SystemRole

Returns:

a SystemRolePrincipal

calculatePrincipalID

public static java.lang.String calculatePrincipalID(blackboard.data.user.User.SystemRole role)

Returns a string that represents the System Role Principal ID

Parameters:

role - a User.SystemRole

Returns:

a String that represents the PrincipalID for the User.SystemRole