Package com.mendix.workflows

Enum Class WorkflowState

java.lang.Object

java.lang.Enum<WorkflowState>

com.mendix.workflows.WorkflowState

All Implemented Interfaces:

Serializable, Comparable<WorkflowState>, Constable

public enum WorkflowState
extends Enum<WorkflowState>

Represents the state of a workflow instance.

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
ABORTED	The state after the admin abort the workflow instance.
COMPLETED	The terminal state indicates that the workflow instance is finished.
FAILED	The state after a failure occurred during execution of the workflow instance.
IN_PROGRESS	Initial state.
INCOMPATIBLE	The state after introducing incompatible new version of the workflow instead of the current one or when the workflow definition is deleted.
PAUSED	The state after the admin pauses the workflow instance.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the string representation of the workflow state.
static WorkflowState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WorkflowState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IN_PROGRESS

public static final WorkflowState IN_PROGRESS

Initial state.

COMPLETED

public static final WorkflowState COMPLETED

The terminal state indicates that the workflow instance is finished.

PAUSED

public static final WorkflowState PAUSED

The state after the admin pauses the workflow instance. Unpausing brings it back to IN_PROGRESS.

ABORTED

public static final WorkflowState ABORTED

The state after the admin abort the workflow instance.

FAILED

public static final WorkflowState FAILED

The state after a failure occurred during execution of the workflow instance.

INCOMPATIBLE

public static final WorkflowState INCOMPATIBLE

The state after introducing incompatible new version of the workflow instead of the current one or when the workflow definition is deleted.

Method Details

values

public static WorkflowState[] 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 WorkflowState 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

getValue

public String getValue()

Returns the string representation of the workflow state.

Returns:

the string representation