wt.lifecycle
Class State

java.lang.Object
  wt.fc.EnumeratedType
      wt.lifecycle.State

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class State
extends EnumeratedType
implements Serializable

State is a specialization of EnumeratedType to provide localizable state values. The localized values for states are maintained in a resource bundle StateRB, and its locale derivatives

Released is a required state.

Supported API: true

Extendable: false

See Also:

EnumeratedType, wt.lifecycle.StateRB, Serialized Form

Field Summary

static State	INWORK Static final constant Supported API: true
static State	RELEASED Static final constant Supported API: true
static State	UNDERREVIEW Static final constant Supported API: true

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

static State	getStateDefault() Returns the default value (instance) for the State set.
static State[]	getStateSet() Returns a copy of the set of valid values (instances) for the State class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static State	toState(String internal_value) Returns the State instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

equals, getAbbreviatedDisplay, getDisplay, getDisplay, getFullDisplay, getLocalizedMessage, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, hashCode, isDefaultValue, isDefaultValue, isSelectable, main, toEnumeratedType, toEnumeratedType, toString

Methods inherited from class java.lang.Object

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

Field Detail

INWORK

public static final State INWORK

Static final constant

Supported API: true

UNDERREVIEW

public static final State UNDERREVIEW

Static final constant

Supported API: true

RELEASED

public static final State RELEASED

Static final constant

Supported API: true

Method Detail

toState

public static State toState(String internal_value)
                     throws WTInvalidParameterException

Returns the State instance for the internal_value argument.

Supported API: true

Parameters:

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

Returns:

State

Throws:

WTInvalidParameterException

getStateDefault

public static State getStateDefault()

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

Supported API: true

Returns:

State

getStateSet

public static State[] getStateSet()

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

Supported API: true

Returns:

State[]

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[]