wt.project
Class Role

java.lang.Object
  wt.fc.EnumeratedType
      wt.fc.DynamicEnumType
          wt.project.Role

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class Role

extends DynamicEnumType

implements Serializable

Role is a specialization of EnumeratedType to provide localizable role names The localized values for roles are maintained in a resource bundle RoleRB, and its locale derivatives

Submitter and Promoter are required roles for life cycle services.

Supported API: true

Extendable: false

See Also:

EnumeratedType, wt.project.RoleRB, Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

private static String	CLASS_RESOURCE
private static String	CLASSNAME
private static HashMap	dynamicSet
private static Hashtable	localeSets
static Role	OBSERVER Static final constant Supported API: false
static Role	PROMOTER Static final constant Supported API: false
private static String	RESOURCE
static Role	REVIEWER Static final constant Supported API: false
static Role	SUBMITTER Static final constant Supported API: false
private static EnumeratedType[]	valueSet

Fields inherited from class wt.fc.DynamicEnumType

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Constructor Summary

protected

Role() Used by sub-classes that need a default constructor.

Method Summary

protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
static Role	getRoleDefault() Returns the default value (instance) for the Role set.
static Role[]	getRoleSet() Returns a copy of the set of valid values (instances) for the Role class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static Role	newRole(int secretHandshake) Used by EnumeratedType for constructing instances of Role, from a resource bundle.
static Role	toRole(String internal_value) Returns the Role instance for the internal_value argument.
protected EnumeratedType[]	valueSet() Returns a reference to the set of valid values (instances) for this instance.

Methods inherited from class wt.fc.DynamicEnumType

getDisplay, getShortDescription

Methods inherited from class wt.fc.EnumeratedType

defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, getValidSet, getValue, hashCode, instantiateSet, isDefaultValue, isDefaultValue, isPrimaryKey, isSelectable, main, readResolve, toEnumeratedType, toEnumeratedType, toEnumeratedType, toString, validateFriendship

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASS_RESOURCE

private static final String CLASS_RESOURCE

See Also:

Constant Field Values

valueSet

private static final EnumeratedType[] valueSet

localeSets

private static Hashtable localeSets

dynamicSet

private static final HashMap dynamicSet

SUBMITTER

public static final Role SUBMITTER

Static final constant

Supported API: false

PROMOTER

public static final Role PROMOTER

Static final constant

Supported API: false

REVIEWER

public static final Role REVIEWER

Static final constant

Supported API: false

OBSERVER

public static final Role OBSERVER

Static final constant

Supported API: false

Constructor Detail

Role

protected Role()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newRole

public static Role newRole(int secretHandshake)
                    throws IllegalAccessException

Used by EnumeratedType for constructing instances of Role, from a resource bundle.

Supported API: false

Parameters:

secretHandshake -

Returns:

Role

Throws:

IllegalAccessException

toRole

public static Role toRole(String internal_value)
                   throws WTInvalidParameterException

Returns the Role instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of Role.

Returns:

Role

Throws:

WTInvalidParameterException

getRoleDefault

public static Role getRoleDefault()

Returns the default value (instance) for the Role set.

Supported API: true

Returns:

Role

getRoleSet

public static Role[] getRoleSet()

Returns a copy of the set of valid values (instances) for the Role class.

Supported API: true

Returns:

Role[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]

valueSet

protected EnumeratedType[] valueSet()

Returns a reference to the set of valid values (instances) for this instance.

Supported API: false

Specified by:

valueSet in class EnumeratedType

Returns:

EnumeratedType[]

getLocaleSet

protected EnumeratedType[] getLocaleSet(Locale locale)

Returns the set of values (instances) for this instance, for the specified locale.

Supported API: false

Specified by:

getLocaleSet in class EnumeratedType

Parameters:

locale -

Returns:

EnumeratedType[]

initializeLocaleSet

private static EnumeratedType[] initializeLocaleSet(Locale locale)
                                             throws Throwable

Parameters:

locale -

Returns:

EnumeratedType[]

Throws:

Throwable