wt.workflow.engine
Class WfState

java.lang.Object
  wt.fc.EnumeratedType
      wt.workflow.engine.WfState

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class WfState

extends EnumeratedType

implements Serializable

The WfState class enumerates the possible states an execution object may be in.

Supported API: false

Extendable: false

See Also:

WfExecutionObject, 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 WfState	CLOSED Supported API: false
static WfState	CLOSED_ABORTED Supported API: false
static WfState	CLOSED_COMPLETED Supported API: false
static WfState	CLOSED_COMPLETED_EXECUTED Supported API: false
static WfState	CLOSED_COMPLETED_NOT_EXECUTED Supported API: false
static WfState	CLOSED_TERMINATED Supported API: false
private static Hashtable	localeSets
static WfState	OPEN Supported API: false
static WfState	OPEN_NOT_RUNNING Supported API: false
static WfState	OPEN_NOT_RUNNING_NOT_STARTED Supported API: false
static WfState	OPEN_NOT_RUNNING_SUSPENDED Supported API: false
static WfState	OPEN_NOT_RUNNING_SUSPENDED_DISABLED Supported API: false
static WfState	OPEN_NOT_RUNNING_SUSPENDED_INTERMITTED Supported API: false
static WfState	OPEN_RUNNING Supported API: false
private static String	RESOURCE
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

WfState() 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.
Enumeration	getSubstates() Returns an enumeration (of type WfState) containing all sub-states of the current object, including the object itself.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static WfState	getWfStateDefault() Returns the default value (instance) for the WfState set.
static WfState[]	getWfStateSet() Returns a copy of the set of valid values (instances) for the WfState class.
boolean	includes(WfState state) Returns true is the state passed as argument is a substate of the current object; false otherwise.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static WfState	newWfState(int secretHandshake) Used by EnumeratedType for constructing instances of WfState, from a resource bundle.
static WfState	toWfState(String internal_value) Returns the WfState 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

OPEN

public static final WfState OPEN

Supported API: false

CLOSED

public static final WfState CLOSED

Supported API: false

OPEN_RUNNING

public static final WfState OPEN_RUNNING

Supported API: false

OPEN_NOT_RUNNING

public static final WfState OPEN_NOT_RUNNING

Supported API: false

OPEN_NOT_RUNNING_NOT_STARTED

public static final WfState OPEN_NOT_RUNNING_NOT_STARTED

Supported API: false

OPEN_NOT_RUNNING_SUSPENDED

public static final WfState OPEN_NOT_RUNNING_SUSPENDED

Supported API: false

CLOSED_COMPLETED

public static final WfState CLOSED_COMPLETED

Supported API: false

CLOSED_TERMINATED

public static final WfState CLOSED_TERMINATED

Supported API: false

CLOSED_ABORTED

public static final WfState CLOSED_ABORTED

Supported API: false

OPEN_NOT_RUNNING_SUSPENDED_DISABLED

public static final WfState OPEN_NOT_RUNNING_SUSPENDED_DISABLED

Supported API: false

OPEN_NOT_RUNNING_SUSPENDED_INTERMITTED

public static final WfState OPEN_NOT_RUNNING_SUSPENDED_INTERMITTED

Supported API: false

CLOSED_COMPLETED_NOT_EXECUTED

public static final WfState CLOSED_COMPLETED_NOT_EXECUTED

Supported API: false

CLOSED_COMPLETED_EXECUTED

public static final WfState CLOSED_COMPLETED_EXECUTED

Supported API: false

Constructor Detail

WfState

protected WfState()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newWfState

public static WfState newWfState(int secretHandshake)
                          throws IllegalAccessException

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

Supported API: false

Parameters:

secretHandshake -

Returns:

WfState

Throws:

IllegalAccessException

toWfState

public static WfState toWfState(String internal_value)
                         throws WTInvalidParameterException

Returns the WfState instance for the internal_value argument.

Supported API: false

Parameters:

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

Returns:

WfState

Throws:

WTInvalidParameterException

getWfStateDefault

public static WfState getWfStateDefault()

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

Supported API: false

Returns:

WfState

getWfStateSet

public static WfState[] getWfStateSet()

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

Supported API: false

Returns:

WfState[]

getValueSet

public EnumeratedType[] getValueSet()

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

Supported API: false

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

includes

public boolean includes(WfState state)

Returns true is the state passed as argument is a substate of the current object; false otherwise.

Supported API: false

Parameters:

state -

Returns:

boolean

getSubstates

public Enumeration getSubstates()

Returns an enumeration (of type WfState) containing all sub-states of the current object, including the object itself.

Supported API: false

Returns:

Enumeration