blackboard.data.course
Class CourseMembership.Role

java.lang.Object
  blackboard.base.BbEnum
      blackboard.data.course.CourseMembership.Role

All Implemented Interfaces:

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

Enclosing class:

CourseMembership

public static final class CourseMembership.Role
extends BbEnum
implements Entitled

See Also:

Serialized Form

Field Summary

static CourseMembership.Role	COURSE_BUILDER
static CourseMembership.Role	DEFAULT
static CourseMembership.Role	GRADER
static CourseMembership.Role	GUEST
static CourseMembership.Role	INSTRUCTOR
static CourseMembership.Role	NONE
static CourseMembership.Role	STUDENT
static CourseMembership.Role	TEACHING_ASSISTANT

Method Summary

int	comparePrecedence(CourseMembership.Role role) Compare the precedence of the roles.
static CourseMembership.Role	fromExternalString(java.lang.String externalString) Returns the CourseMembership.Role element specified by the externalString.
static CourseMembership.Role	fromFieldName(java.lang.String fieldName) Returns the FormattedText.Type element specified by the fieldName.
Entitlements	getEntitlements() Return the set of entitlements held by this object.
static CourseMembership.Role[]	getValues() Returns an array of all of the elements in this enumeration.

Methods inherited from class blackboard.base.BbEnum

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

Methods inherited from class java.lang.Object

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

Field Detail

INSTRUCTOR

public static final CourseMembership.Role INSTRUCTOR

TEACHING_ASSISTANT

public static final CourseMembership.Role TEACHING_ASSISTANT

COURSE_BUILDER

public static final CourseMembership.Role COURSE_BUILDER

GRADER

public static final CourseMembership.Role GRADER

STUDENT

public static final CourseMembership.Role STUDENT

GUEST

public static final CourseMembership.Role GUEST

NONE

public static final CourseMembership.Role NONE

DEFAULT

public static final CourseMembership.Role DEFAULT

Method Detail

comparePrecedence

public int comparePrecedence(CourseMembership.Role role)

Compare the precedence of the roles.

Parameters:

role - The role to compare this with

Returns:

negative integer if this role takes higher prcedence, 0 if they are the same, positive integer if the other role takes higher precedence

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 CourseMembership.Role[] getValues()

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

fromExternalString

public static CourseMembership.Role fromExternalString(java.lang.String externalString)
                                                throws java.lang.IllegalArgumentException

Returns the CourseMembership.Role 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 CourseMembership.Role 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.