blackboard.data.user
Class User.SystemRole

java.lang.Object
  blackboard.base.BbEnum
      blackboard.data.user.User.SystemRole

All Implemented Interfaces:

Entitled, java.io.Serializable, java.lang.Comparable

Enclosing class:

User

public static final class User.SystemRole
extends BbEnum
implements Entitled

An enumeration for System Roles assigned to users in the system. The system role is what determines access privileges for administrative functions in the system.

Since:

Blackboard 5.0

See Also:

Serialized Form

Field Summary

static User.SystemRole	ACCOUNT_ADMIN Account Administrator role.
static User.SystemRole	CARD_OFFICE_ADMIN Manages the front-end settings (tabs, modules, etc.) for portal-ecommerce functionality
static User.SystemRole	COURSE_CREATOR Course Creator role.
static User.SystemRole	COURSE_SUPPORT Course Support role.
static User.SystemRole	DEFAULT Default role is USER
static User.SystemRole	ECOMMERCE_ADMIN Manages the back-end settings for portal-ecommerce functionality
static User.SystemRole	GUEST Guest role.
static User.SystemRole	INTEGRATION This role is private, used only for special processes that interact for data integration authentication.
static User.SystemRole	LMS_INTEGRATION_ADMIN Manages the front-end portal-ecommerce functionality related to purchases
static User.SystemRole	NONE No explicit role.
static User.SystemRole	OBSERVER Observer role.
static User.SystemRole	PORTAL Portal Administrator role.
static User.SystemRole	STORE_ADMIN Manages the front-end portal-ecommerce functionality related to purchases
static User.SystemRole	SYSTEM_ADMIN System Administrator role.
static User.SystemRole	SYSTEM_SUPPORT System Support role.
static User.SystemRole	USER Normal user role.

Method Summary

int	compareTo(java.lang.Object obj) compareTo
boolean	equals(java.lang.Object obj) equals
static User.SystemRole	fromExternalString(java.lang.String externalString) Returns the User.SystemRole element specified by the externalString .
static User.SystemRole	fromFieldName(java.lang.String fieldName) Returns the FormattedText.Type element specified by the fieldName .
static BbEnum	fromFieldName(java.lang.String fieldName, java.lang.Class enumClass)
static BbEnum	fromFieldName(java.lang.String fieldName, java.lang.Class enumClass, boolean returnDefault) Returns the User.SystemRole element specified by the fieldName.
java.lang.String	getDisplayName() Returns a displayable representation of this User System Role
Entitlements	getEntitlements() Return the set of entitlements held by this object.
java.lang.String	getIdentifier() Returns the unique identifier of this User System Role
static User.SystemRole[]	getValues() Returns an array of all of the elements in this enumeration.
int	hashCode() hashCode
static User.SystemRole	mapToUserSystemRole(java.lang.String identifier) mapToUserSystemRole

Methods inherited from class blackboard.base.BbEnum

defineAlias, defineDefault, fromExternalString, getDefaultElement, getValues, isDefault, readResolve, toExternalString, toFieldName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SYSTEM_ADMIN

public static final User.SystemRole SYSTEM_ADMIN

System Administrator role.

SYSTEM_SUPPORT

public static final User.SystemRole SYSTEM_SUPPORT

System Support role.

COURSE_CREATOR

public static final User.SystemRole COURSE_CREATOR

Course Creator role.

COURSE_SUPPORT

public static final User.SystemRole COURSE_SUPPORT

Course Support role.

ACCOUNT_ADMIN

public static final User.SystemRole ACCOUNT_ADMIN

Account Administrator role.

GUEST

public static final User.SystemRole GUEST

Guest role.

USER

public static final User.SystemRole USER

Normal user role.

OBSERVER

public static final User.SystemRole OBSERVER

Observer role.

INTEGRATION

public static final User.SystemRole INTEGRATION

This role is private, used only for special processes that interact for data integration authentication.

PORTAL

public static final User.SystemRole PORTAL

Portal Administrator role.

ECOMMERCE_ADMIN

public static final User.SystemRole ECOMMERCE_ADMIN

Manages the back-end settings for portal-ecommerce functionality

CARD_OFFICE_ADMIN

public static final User.SystemRole CARD_OFFICE_ADMIN

Manages the front-end settings (tabs, modules, etc.) for portal-ecommerce functionality

STORE_ADMIN

public static final User.SystemRole STORE_ADMIN

Manages the front-end portal-ecommerce functionality related to purchases

LMS_INTEGRATION_ADMIN

public static final User.SystemRole LMS_INTEGRATION_ADMIN

Manages the front-end portal-ecommerce functionality related to purchases

NONE

public static final User.SystemRole NONE

No explicit role. Identical to USER role.

DEFAULT

public static final User.SystemRole DEFAULT

Default role is USER

Method Detail

getEntitlements

public Entitlements getEntitlements()

Description copied from interface: Entitled

Return the set of entitlements held by this object.

Specified by:

getEntitlements in interface Entitled

Returns:

Entitlements instance

getValues

public static User.SystemRole[] getValues()

Returns an array of all of the elements in this enumeration.

fromExternalString

public static User.SystemRole fromExternalString(java.lang.String externalString)
                                          throws java.lang.IllegalArgumentException

Returns the User.SystemRole element specified by the externalString .

Throws:

java.lang.IllegalArgumentException - if the given string is not an external representation of one of the elements this enumeration class.

fromFieldName

public static User.SystemRole fromFieldName(java.lang.String fieldName)
                                     throws java.lang.IllegalArgumentException

Returns the FormattedText.Type element specified by the fieldName .

Throws:

java.lang.IllegalArgumentException - if the given string is not a short representation of one of the elements in this enumeration class.

fromFieldName

public static BbEnum fromFieldName(java.lang.String fieldName,
                                   java.lang.Class enumClass)
                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

fromFieldName

public static BbEnum fromFieldName(java.lang.String fieldName,
                                   java.lang.Class enumClass,
                                   boolean returnDefault)
                            throws java.lang.IllegalArgumentException

Returns the User.SystemRole element specified by the fieldName.

Throws:

java.lang.IllegalArgumentException - if the given string is not an external representation of one of the elements this enumeration class.

mapToUserSystemRole

public static User.SystemRole mapToUserSystemRole(java.lang.String identifier)

mapToUserSystemRole

getIdentifier

public java.lang.String getIdentifier()

Returns the unique identifier of this User System Role

getDisplayName

public java.lang.String getDisplayName()

Returns a displayable representation of this User System Role

equals

public boolean equals(java.lang.Object obj)

equals

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.lang.Object obj)

compareTo

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class BbEnum

Parameters:

obj - the object to be compared to.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

hashCode

public int hashCode()

hashCode

Overrides:

hashCode in class java.lang.Object