org.wfmc.wapi
Class WMProcessInstanceState

java.lang.Object
  org.wfmc.wapi.WMObjectState
      org.wfmc.wapi.WMProcessInstanceState

All Implemented Interfaces:

java.io.Serializable

public final class WMProcessInstanceState

extends WMObjectState

Describes the supported states of a process instance. The states and their descriptions are taken from WfMC Interface 2/3.

Author:

Adrian Price

See Also:

Serialized Form

Field Summary

static int	ABORT_ACTION Abort the instance.
static WMProcessInstanceState	CLOSED_ABORTED Enactment of the process instance has been aborted by a user.
static int	CLOSED_ABORTED_INT
static java.lang.String	CLOSED_ABORTED_TAG
static WMProcessInstanceState	CLOSED_COMPLETED Enactment of the process instance has completed normally.
static int	CLOSED_COMPLETED_INT
static java.lang.String	CLOSED_COMPLETED_TAG
static WMProcessInstanceState	CLOSED_TERMINATED Enactment of the process instance has been terminated by a user.
static int	CLOSED_TERMINATED_INT
static java.lang.String	CLOSED_TERMINATED_TAG
static int	COMPLETE_ACTION Complete the instance.
static int	CREATE_ACTION Create the instance.
static int	DELETE_ACTION Delete the instance.
static WMProcessInstanceState	OPEN_NOTRUNNING_NOTSTARTED The process instance has been created, but was not started yet.
static int	OPEN_NOTRUNNING_NOTSTARTED_INT
static java.lang.String	OPEN_NOTRUNNING_NOTSTARTED_TAG
static WMProcessInstanceState	OPEN_NOTRUNNING_SUSPENDED Execution of the process instance was temporarily suspended.
static int	OPEN_NOTRUNNING_SUSPENDED_INT
static java.lang.String	OPEN_NOTRUNNING_SUSPENDED_TAG
static WMProcessInstanceState	OPEN_RUNNING The process instance is executing.
static int	OPEN_RUNNING_INT
static java.lang.String	OPEN_RUNNING_TAG
static int	RESUME_ACTION Resume the instance.
static int	START_ACTION Start the instance.
static int	SUSPEND_ACTION Suspend the instance.
static int	TERMINATE_ACTION Terminate the instance.

Fields inherited from class org.wfmc.wapi.WMObjectState

_state, DEFAULT_INT, FORCED_ACTION, ILLEGAL_ACTION, MESSAGE, NO_ACTION

Method Summary

protected int[]	getActionsByState() Returns the transitions from the current state, indexed by new state.
protected int[]	getStatesByAction() Returns the transitions from the current state, indexed by action.
protected java.lang.String[]	getTags() Returns the list of all state tags applicable to this instance's class.
protected WMObjectState[]	getValues() Returns the list of all state values applicable to this instance's class.
boolean	isClosed()
static boolean	isClosed(int state)
boolean	isOpen()
static boolean	isOpen(int state)
static WMProcessInstanceState[]	states()
static WMProcessInstanceState	valueOf(int state)
static WMProcessInstanceState	valueOf(java.lang.String state)

Methods inherited from class org.wfmc.wapi.WMObjectState

checkTransition, checkTransition, equals, getStates, getValue, hashCode, readResolve, stateFromAction, stringValue, toString, value, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_NOTRUNNING_NOTSTARTED_INT

public static final int OPEN_NOTRUNNING_NOTSTARTED_INT

See Also:

OPEN_NOTRUNNING_NOTSTARTED, Constant Field Values

OPEN_NOTRUNNING_SUSPENDED_INT

public static final int OPEN_NOTRUNNING_SUSPENDED_INT

See Also:

OPEN_NOTRUNNING_SUSPENDED, Constant Field Values

OPEN_RUNNING_INT

public static final int OPEN_RUNNING_INT

See Also:

OPEN_RUNNING, Constant Field Values

CLOSED_ABORTED_INT

public static final int CLOSED_ABORTED_INT

See Also:

CLOSED_ABORTED, Constant Field Values

CLOSED_TERMINATED_INT

public static final int CLOSED_TERMINATED_INT

See Also:

CLOSED_TERMINATED, Constant Field Values

CLOSED_COMPLETED_INT

public static final int CLOSED_COMPLETED_INT

See Also:

CLOSED_COMPLETED, Constant Field Values

OPEN_NOTRUNNING_NOTSTARTED_TAG

public static final java.lang.String OPEN_NOTRUNNING_NOTSTARTED_TAG

See Also:

OPEN_NOTRUNNING_NOTSTARTED, Constant Field Values

OPEN_NOTRUNNING_SUSPENDED_TAG

public static final java.lang.String OPEN_NOTRUNNING_SUSPENDED_TAG

See Also:

OPEN_NOTRUNNING_SUSPENDED, Constant Field Values

OPEN_RUNNING_TAG

public static final java.lang.String OPEN_RUNNING_TAG

See Also:

OPEN_RUNNING, Constant Field Values

CLOSED_ABORTED_TAG

public static final java.lang.String CLOSED_ABORTED_TAG

See Also:

CLOSED_ABORTED, Constant Field Values

CLOSED_TERMINATED_TAG

public static final java.lang.String CLOSED_TERMINATED_TAG

See Also:

CLOSED_TERMINATED, Constant Field Values

CLOSED_COMPLETED_TAG

public static final java.lang.String CLOSED_COMPLETED_TAG

See Also:

CLOSED_COMPLETED, Constant Field Values

OPEN_NOTRUNNING_NOTSTARTED

public static final WMProcessInstanceState OPEN_NOTRUNNING_NOTSTARTED

The process instance has been created, but was not started yet.

OPEN_NOTRUNNING_SUSPENDED

public static final WMProcessInstanceState OPEN_NOTRUNNING_SUSPENDED

Execution of the process instance was temporarily suspended.

OPEN_RUNNING

public static final WMProcessInstanceState OPEN_RUNNING

The process instance is executing.

CLOSED_ABORTED

public static final WMProcessInstanceState CLOSED_ABORTED

Enactment of the process instance has been aborted by a user. (See the specification of WMAbortProcessInstance for a definition of abortion in contrast to termination).

CLOSED_TERMINATED

public static final WMProcessInstanceState CLOSED_TERMINATED

Enactment of the process instance has been terminated by a user. (See the specification of WMTerminateProcessInstance for a definition of termination in contrast to abortion).

CLOSED_COMPLETED

public static final WMProcessInstanceState CLOSED_COMPLETED

Enactment of the process instance has completed normally. (i.e., was not forced by a user).

ABORT_ACTION

public static final int ABORT_ACTION

Abort the instance.

See Also:

Constant Field Values

COMPLETE_ACTION

public static final int COMPLETE_ACTION

Complete the instance.

See Also:

Constant Field Values

CREATE_ACTION

public static final int CREATE_ACTION

Create the instance.

See Also:

Constant Field Values

DELETE_ACTION

public static final int DELETE_ACTION

Delete the instance.

See Also:

Constant Field Values

RESUME_ACTION

public static final int RESUME_ACTION

Resume the instance.

See Also:

Constant Field Values

START_ACTION

public static final int START_ACTION

Start the instance.

See Also:

Constant Field Values

SUSPEND_ACTION

public static final int SUSPEND_ACTION

Suspend the instance.

See Also:

Constant Field Values

TERMINATE_ACTION

public static final int TERMINATE_ACTION

Terminate the instance.

See Also:

Constant Field Values

Method Detail

valueOf

public static WMProcessInstanceState valueOf(java.lang.String state)

valueOf

public static WMProcessInstanceState valueOf(int state)

states

public static WMProcessInstanceState[] states()

isClosed

public boolean isClosed()

isClosed

public static boolean isClosed(int state)

isOpen

public boolean isOpen()

isOpen

public static boolean isOpen(int state)

getTags

protected java.lang.String[] getTags()

Description copied from class: WMObjectState

Returns the list of all state tags applicable to this instance's class. The array is indexed by state code. This is be a reference to a final array defined statically in the instance's subclass.

Specified by:

getTags in class WMObjectState

Returns:

Array of state tags.

getValues

protected WMObjectState[] getValues()

Description copied from class: WMObjectState

Returns the list of all state values applicable to this instance's class. This is a reference to a final array defined statically in the instance's subclass.

Specified by:

getValues in class WMObjectState

Returns:

Array of state objects.

getStatesByAction

protected int[] getStatesByAction()

Description copied from class: WMObjectState

Returns the transitions from the current state, indexed by action. Illegal transitions are marked by the array element value WMObjectState.ILLEGAL_ACTION.

Specified by:

getStatesByAction in class WMObjectState

Returns:

Array of state codes. This is a reference to a final array defined statically in the instance's subclass.

getActionsByState

protected int[] getActionsByState()

Description copied from class: WMObjectState

Returns the transitions from the current state, indexed by new state. Illegal transitions are marked by the array element value WMObjectState.ILLEGAL_ACTION.

Specified by:

getActionsByState in class WMObjectState

Returns:

Array of action codes. This is a reference to a final array defined statically in the instance's subclass.