com.starteam
Class User.GeographicTerritory

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

User

public static final class User.GeographicTerritory
extends EnumeratedValue

The accessible territory for the logged in User Account.

See Also:

Serialized Form

Field Summary

static User.GeographicTerritory[]	ALL All valid geographic territories
static User.GeographicTerritory	AMERICAS Americas
static User.GeographicTerritory	ASIA Asia
static User.GeographicTerritory	EUROPE Europe
static User.GeographicTerritory	UNASSIGNED Territory has not yet been assigned

Method Summary

boolean	equals(java.lang.Object o) Compares two Geographic Territories for equality
static User.GeographicTerritory	fromID(int id) Gets the GeographicTerritory 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 Geographic Territory.
int	getID() The ID of the corresponding Territory
java.lang.String	getName() The name of this Territory
int	hashCode() returns a unique hash for this instance

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

UNASSIGNED

public static final User.GeographicTerritory UNASSIGNED

Territory has not yet been assigned

AMERICAS

public static final User.GeographicTerritory AMERICAS

Americas

EUROPE

public static final User.GeographicTerritory EUROPE

Europe

ASIA

public static final User.GeographicTerritory ASIA

Asia

ALL

public static final User.GeographicTerritory[] ALL

All valid geographic territories

Method Detail

getName

public java.lang.String getName()

The name of this Territory

Returns:

the name of this Territory

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the Geographic Territory.

Overrides:

getDisplayName in class EnumeratedValue

Returns:

the display name of this Geographic Territory

getID

public int getID()

The ID of the corresponding Territory

Returns:

The ID of this Territory.

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.GeographicTerritory fromID(int id)

Gets the GeographicTerritory value corresponding to the given ID.

Parameters:

id - A GeographicTerritory ID.

Returns:

The corresponding GeographicTerritory value, or null.

equals

public boolean equals(java.lang.Object o)

Compares two Geographic Territories for equality

Overrides:

equals in class EnumeratedValue

Parameters:

o - the object to compare

Returns:

true if the two objects are identical

hashCode

public int hashCode()

Description copied from class: EnumeratedValue

returns a unique hash for this instance

Overrides:

hashCode in class EnumeratedValue

Returns:

a unique hash for this instance