blackboard.data.user
Class User.InstRole

java.lang.Object
  |
  +--blackboard.base.BbEnum
        |
        +--blackboard.data.user.User.InstRole

All Implemented Interfaces:

java.lang.Comparable

Enclosing class:

User

public static final class User.InstRole

extends BbEnum

An enumeration describing the institution roles used in the Portal.

Since:

Blackboard 6.0

Version:

$Revision: 4 $ $Date: 11/26/03 10:05a $

Field Summary

static User.InstRole	ALUMNI
static User.InstRole	DEFAULT
static User.InstRole	FACULTY
static User.InstRole	GUEST
static User.InstRole	OBSERVER
static User.InstRole	OTHER
static User.InstRole	PROSPECTIVE_STUDENT
static User.InstRole	ROLE_10
static User.InstRole	ROLE_11
static User.InstRole	ROLE_12
static User.InstRole	ROLE_13
static User.InstRole	ROLE_14
static User.InstRole	ROLE_15
static User.InstRole	ROLE_16
static User.InstRole	ROLE_17
static User.InstRole	ROLE_18
static User.InstRole	ROLE_19
static User.InstRole	ROLE_20
static User.InstRole	ROLE_9
static User.InstRole	STAFF
static User.InstRole	STUDENT

Method Summary

static User.InstRole	fromExternalString(java.lang.String externalString) Returns the User.InstRole element specified by the externalString.
java.lang.String	getDisplayName() Returns a displayable representation of the given Institution Role
static User.InstRole[]	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, toExternalString, toFieldName, toString

Methods inherited from class java.lang.Object

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

Field Detail

STUDENT

public static final User.InstRole STUDENT

FACULTY

public static final User.InstRole FACULTY

STAFF

public static final User.InstRole STAFF

ALUMNI

public static final User.InstRole ALUMNI

PROSPECTIVE_STUDENT

public static final User.InstRole PROSPECTIVE_STUDENT

GUEST

public static final User.InstRole GUEST

OTHER

public static final User.InstRole OTHER

OBSERVER

public static final User.InstRole OBSERVER

ROLE_9

public static final User.InstRole ROLE_9

ROLE_10

public static final User.InstRole ROLE_10

ROLE_11

public static final User.InstRole ROLE_11

ROLE_12

public static final User.InstRole ROLE_12

ROLE_13

public static final User.InstRole ROLE_13

ROLE_14

public static final User.InstRole ROLE_14

ROLE_15

public static final User.InstRole ROLE_15

ROLE_16

public static final User.InstRole ROLE_16

ROLE_17

public static final User.InstRole ROLE_17

ROLE_18

public static final User.InstRole ROLE_18

ROLE_19

public static final User.InstRole ROLE_19

ROLE_20

public static final User.InstRole ROLE_20

DEFAULT

public static final User.InstRole DEFAULT

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns a displayable representation of the given Institution Role

getValues

public static User.InstRole[] getValues()

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

fromExternalString

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

Returns the User.InstRole 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.