blackboard.cms.filesystem.security
Class PortalRolePrincipal

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

public class PortalRolePrincipal

extends CSPrincipal

Object used to represent a CSPrincipal for a given Portal Role

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

static java.lang.String	calculatePrincipalID(blackboard.data.role.PortalRole role) Returns a string that represents the Portal Role Principal ID
static PortalRolePrincipal	createInstance(blackboard.data.role.PortalRole role) Create an instance of PortalRolePrincipal
blackboard.data.role.PortalRole	getPortalRole() Returns the PortalRole associated with this PortalRolePrincipal

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

getPortalRole

public blackboard.data.role.PortalRole getPortalRole()

Returns the PortalRole associated with this PortalRolePrincipal

Returns:

a PortalRole

createInstance

public static PortalRolePrincipal createInstance(blackboard.data.role.PortalRole role)

Create an instance of PortalRolePrincipal

Parameters:

role - a PortalRole

Returns:

a PortalRolePrincipal

calculatePrincipalID

public static java.lang.String calculatePrincipalID(blackboard.data.role.PortalRole role)

Returns a string that represents the Portal Role Principal ID

Parameters:

role - a PortalRole

Returns:

a String that represents the PrincipalID for the Portal Role