wt.vc
Class IterationState

java.lang.Object
  wt.fc.EnumeratedType
      wt.vc.IterationState

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class IterationState

extends EnumeratedType

implements Serializable

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

private static String	CLASS_RESOURCE
private static String	CLASSNAME
static IterationState	CONTROLLED A constant that predefines an iteration's state of being controlled.
private static Hashtable	localeSets
private static String	RESOURCE
protected static IterationState	UNCONTROLLED A constant that predefines an iteration's state of being uncontrolled.
private static EnumeratedType[]	valueSet

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Constructor Summary

protected

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

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.
protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
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 IterationState	newIterationState(int secretHandshake) Used by EnumeratedType for constructing instances of IterationState, from a resource bundle.
static IterationState	toIterationState(String internal_value) Returns the IterationState 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.EnumeratedType

defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, 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

CONTROLLED

public static final IterationState CONTROLLED

A constant that predefines an iteration's state of being controlled. This is the typical and default iteration state.

Supported API: false

UNCONTROLLED

protected static final IterationState UNCONTROLLED

A constant that predefines an iteration's state of being uncontrolled. This is the atypical iteration state and is only used by this service to indicate that the iteration is no longer strictly controlled and, for example, may be deleted without regard to business rules, except for access control.

Supported API: false

Constructor Detail

IterationState

protected IterationState()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newIterationState

public static IterationState newIterationState(int secretHandshake)
                                        throws IllegalAccessException

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

Supported API: false

Parameters:

secretHandshake -

Returns:

IterationState

Throws:

IllegalAccessException

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

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