com.starteam
Class User.Status

java.lang.Object
  com.starteam.EnumeratedValue
      com.starteam.User.Status

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

User

public static final class User.Status
extends EnumeratedValue

The current status of the User Account.

See Also:

Serialized Form

Field Summary

static User.Status[]	ALL All legal states
static User.Status	LOCKED_OUT Locked Out
static User.Status	NORMAL Normal
static User.Status	PASSWORD_CHANGE_NOTIFIED Password Change Notified
static User.Status	PASSWORD_CHANGE_REQUIRED password Change Required
static User.Status	SUSPENDED Suspended

Method Summary

boolean	equals(java.lang.Object o) Compares this object with another Status for equality
static User.Status	fromID(int id) Gets the Status value corresponding to the given ID.
int	getCode() Return the enum code for this object.
java.lang.String	getDisplayName() Returns the display name of the Status.
int	getID() The ID of the corresponding Status
java.lang.String	getName() A friendly name for this Status
int	hashCode() Returns a hashCode for this Status

Methods inherited from class com.starteam.EnumeratedValue

addChild, assignParent, copy, disable, enable, findChild, getChildValues, getDebugString, getDepthInHierarchy, getDisplayNameTranslations, getInternalName, getParentValue, getSortOrder, hasChildValues, isClosedState, isDisabled, isEnabled, isEqualTo, isLeafValue, isRootValue, isSelectable, setAfter, setChildValues, setClosedState, setDisplayName, setDisplayNameTranslations, setEnabled, setInternalName, setSelectable, setSortOrder, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final User.Status NORMAL

Normal

LOCKED_OUT

public static final User.Status LOCKED_OUT

Locked Out

SUSPENDED

public static final User.Status SUSPENDED

Suspended

PASSWORD_CHANGE_REQUIRED

public static final User.Status PASSWORD_CHANGE_REQUIRED

password Change Required

PASSWORD_CHANGE_NOTIFIED

public static final User.Status PASSWORD_CHANGE_NOTIFIED

Password Change Notified

ALL

public static final User.Status[] ALL

All legal states

Method Detail

getName

public java.lang.String getName()

A friendly name for this Status

Returns:

a friendly name for this Status

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the Status.

Overrides:

getDisplayName in class EnumeratedValue

Returns:

the display name of this Status

getID

public int getID()

The ID of the corresponding Status

Returns:

The ID of this Status value.

getCode

public int getCode()

Return the enum code for this object.

Overrides:

getCode in class EnumeratedValue

Returns:

the enum code for this object.

fromID

public static User.Status fromID(int id)

Gets the Status value corresponding to the given ID.

Parameters:

id - A Status ID.

Returns:

The corresponding Status value, or null.

equals

public boolean equals(java.lang.Object o)

Compares this object with another Status for equality

Overrides:

equals in class EnumeratedValue

Parameters:

o - the Object to compare

Returns:

true if the two are identical

hashCode

public int hashCode()

Returns a hashCode for this Status

Overrides:

hashCode in class EnumeratedValue

Returns:

a hashCode for this Status