wt.vc
Class IterationState

java.lang.Object
  extended by wt.fc.EnumeratedType
      extended by wt.vc.IterationState
All Implemented Interfaces:
Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class IterationState
extends EnumeratedType
implements Serializable

IterationState is a specialization of EnumeratedType to provide localizable IterationState names. The localized values for IterationState are maintained in a resource bundle IterationStateRB.

Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface wt.meta.EnumeratedType
DEFAULT_VALUE, ORDER, SELECTABLE
 
Method Summary
static IterationState getIterationStateDefault()
          Returns the default value (instance) for the IterationState set.
static IterationState[] getIterationStateSet()
          Returns a copy of the set of valid values (instances) for the IterationState class.
 EnumeratedType[] getValueSet()
          Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static IterationState toIterationState(String internal_value)
          Returns the IterationState 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
 

Method Detail

toIterationState

public static IterationState toIterationState(String internal_value)
                                       throws WTInvalidParameterException
Returns the IterationState instance for the internal_value argument.

Supported API: true

Parameters:
internal_value - The internal (persistent) value for a valid instance of IterationState.
Returns:
IterationState
Throws:
WTInvalidParameterException

getIterationStateDefault

public static IterationState getIterationStateDefault()
Returns the default value (instance) for the IterationState set.

Supported API: true

Returns:
IterationState

getIterationStateSet

public static IterationState[] getIterationStateSet()
Returns a copy of the set of valid values (instances) for the IterationState class.

Supported API: true

Returns:
IterationState[]

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