Package com.orchestranetworks.workflow

Enum Class ProcessInstanceStep.WaitTaskState

java.lang.Object

java.lang.Enum<ProcessInstanceStep.WaitTaskState>

com.orchestranetworks.workflow.ProcessInstanceStep.WaitTaskState

All Implemented Interfaces:

Serializable, Comparable<ProcessInstanceStep.WaitTaskState>, Constable

Enclosing interface:

ProcessInstanceStep

public static enum ProcessInstanceStep.WaitTaskState
extends Enum<ProcessInstanceStep.WaitTaskState>

Represents the different states of a wait task.

The life-cycle of a wait task is:

1. The wait task is in the INITIALIZED state. At this time, the workflow is in a waiting state, but the external system has not called yet, if implemented.
2. The wait task is in the WAITING state. At this time, if implemented, the call of the external system has been done.
3. The wait task is in the EVENT_RECEIVED state. At this time, the expected event has been received. But the workflow engine has not handled it yet.
4. The wait task is in the RESUMED state. At this time, the workflow has been resumed. The workflow is not in a waiting state anymore.

If an unexpected error occurs, the token is set to the error state, but the waiting state is not changed. By this way, it is possible to know when the error occurs in the waiting.

Since:

5.6.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENT_RECEIVED	The expected event has been received but the workflow engine has not handled it yet.
INITIALIZED	Workflow's current step is the waiting task, but the external system has not called yet, if implemented.
RESUMED	The resumption of the wait task has been done.
WAITING	If implemented, the external system has been called, the task is waiting.

Method Summary

Modifier and Type	Method	Description
UserMessage	getLabel()	Returns the label of the wait task state.
static ProcessInstanceStep.WaitTaskState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProcessInstanceStep.WaitTaskState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIALIZED

public static final ProcessInstanceStep.WaitTaskState INITIALIZED

Workflow's current step is the waiting task, but the external system has not called yet, if implemented.

WAITING

public static final ProcessInstanceStep.WaitTaskState WAITING

If implemented, the external system has been called, the task is waiting.

EVENT_RECEIVED

public static final ProcessInstanceStep.WaitTaskState EVENT_RECEIVED

The expected event has been received but the workflow engine has not handled it yet.

RESUMED

public static final ProcessInstanceStep.WaitTaskState RESUMED

The resumption of the wait task has been done. The task is not in a waiting state anymore.

Method Details

values

public static ProcessInstanceStep.WaitTaskState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ProcessInstanceStep.WaitTaskState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getLabel

public UserMessage getLabel()

Returns the label of the wait task state.