blackboard.data.user
Class User.InstRole

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

User

Deprecated.

public static final class User.InstRole
extends BbEnum

An enumeration describing the institution roles used in the Portal.

Since:

Blackboard 6.0

Version:

$Revision: #1 $ $Date: 2005/06/27 $

See Also:

Serialized Form

Field Summary

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

Constructor Summary

User.InstRole(java.lang.String enumFieldName, java.lang.String displayName)
Deprecated.

Method Summary

int	compareTo(java.lang.Object obj) Deprecated. The sole method of the Comparable interface.
boolean	equals(java.lang.Object obj) Deprecated.
static User.InstRole	fromExternalString(java.lang.String externalString) Deprecated. Returns the User.InstRole element specified by the externalString.
static BbEnum	fromExternalString(java.lang.String externalString, java.lang.Class enumClass) Deprecated.
static BbEnum	fromFieldName(java.lang.String fieldName, java.lang.Class enumClass) Deprecated.
static BbEnum	fromFieldName(java.lang.String fieldName, java.lang.Class enumClass, boolean returnDefault) Deprecated. Returns the User.InstRole element specified by the fieldName.
java.lang.String	getDefaultDisplayName() Deprecated.
java.lang.String	getDisplayName() Deprecated. Returns a displayable representation of the given Institution Role
static User.InstRole[]	getValues() Deprecated. Returns an array of all of the elements in this enumeration.
int	hashCode() Deprecated.
static User.InstRole	mapToInstRole(Id portalRoleId) Deprecated.
static Id	mapToPortalRoleId(User.InstRole role) Deprecated.

Methods inherited from class blackboard.base.BbEnum

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

Methods inherited from class java.lang.Object

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

Field Detail

STUDENT

public static final User.InstRole STUDENT

Deprecated.

FACULTY

public static final User.InstRole FACULTY

Deprecated.

STAFF

public static final User.InstRole STAFF

Deprecated.

ALUMNI

public static final User.InstRole ALUMNI

Deprecated.

PROSPECTIVE_STUDENT

public static final User.InstRole PROSPECTIVE_STUDENT

Deprecated.

GUEST

public static final User.InstRole GUEST

Deprecated.

OTHER

public static final User.InstRole OTHER

Deprecated.

OBSERVER

public static final User.InstRole OBSERVER

Deprecated.

ROLE_9

public static final User.InstRole ROLE_9

Deprecated.

ROLE_10

public static final User.InstRole ROLE_10

Deprecated.

ROLE_11

public static final User.InstRole ROLE_11

Deprecated.

ROLE_12

public static final User.InstRole ROLE_12

Deprecated.

ROLE_13

public static final User.InstRole ROLE_13

Deprecated.

ROLE_14

public static final User.InstRole ROLE_14

Deprecated.

ROLE_15

public static final User.InstRole ROLE_15

Deprecated.

ROLE_16

public static final User.InstRole ROLE_16

Deprecated.

ROLE_17

public static final User.InstRole ROLE_17

Deprecated.

ROLE_18

public static final User.InstRole ROLE_18

Deprecated.

ROLE_19

public static final User.InstRole ROLE_19

Deprecated.

ROLE_20

public static final User.InstRole ROLE_20

Deprecated.

DEFAULT

public static final User.InstRole DEFAULT

Deprecated.

Constructor Detail

User.InstRole

public User.InstRole(java.lang.String enumFieldName,
                     java.lang.String displayName)

Deprecated.

Method Detail

getDefaultDisplayName

public java.lang.String getDefaultDisplayName()

Deprecated.

getDisplayName

public java.lang.String getDisplayName()

Deprecated.

Returns a displayable representation of the given Institution Role

getValues

public static User.InstRole[] getValues()

Deprecated.

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

fromExternalString

public static BbEnum fromExternalString(java.lang.String externalString,
                                        java.lang.Class enumClass)

Deprecated.

fromExternalString

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

Deprecated.

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.

fromFieldName

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

Deprecated.

Throws:

java.lang.IllegalArgumentException

fromFieldName

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

Deprecated.

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

equals

public boolean equals(java.lang.Object obj)

Deprecated.

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.lang.Object obj)

Deprecated.

Description copied from class: BbEnum

The sole method of the Comparable interface. BbEnum elements are sorted by their external string representation in alphabetical order.

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()

Deprecated.

Overrides:

hashCode in class java.lang.Object

mapToInstRole

public static User.InstRole mapToInstRole(Id portalRoleId)

Deprecated.

mapToPortalRoleId

public static Id mapToPortalRoleId(User.InstRole role)

Deprecated.