org.eclipse.stardust.engine.api.runtime

Class ProcessInstanceState

java.lang.Object

org.eclipse.stardust.common.IntKey

org.eclipse.stardust.engine.api.runtime.ProcessInstanceState

All Implemented Interfaces:

Serializable, Comparable

public class ProcessInstanceState
extends org.eclipse.stardust.common.IntKey

A representation of the state of an process instance. This class also provides human readable values for the process instance states. An process instance changes its state in the course of processing as follows:

1. It is created with state Created.
2. While the process instance is executed, it is in state Active
3. After successful completion it is in state Completed.

For exceptional situations there are two special states:

• Interrupted as an intermediate state if there were system level exception during execution of one of the activity instances.
• Aborted as a termination state for non successful completion.

Author:

ubirkemeyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ProcessInstanceState	Aborted
static int	ABORTED The process instance has been aborted.
static ProcessInstanceState	Aborting
static int	ABORTING The process instance is in progress of being aborted directly by a user.
static ProcessInstanceState	Active
static int	ACTIVE The process instance is running.
static ProcessInstanceState	Completed
static int	COMPLETED The process instance has been completed.
static ProcessInstanceState	Created
static int	CREATED The process instance has just been created.
static ProcessInstanceState	Halted
static int	HALTED The process instance has been halted.
static ProcessInstanceState	Halting
static int	HALTING The process instance is in progress of being halted directly by a user.
static ProcessInstanceState	Interrupted
static int	INTERRUPTED The process instance is interrupted - one of it's activity instances is interrupted.

Method Summary

Methods

Modifier and Type	Method and Description
static Set<ProcessInstanceState>	getAllStates()
static ProcessInstanceState	getState(int value) Factory method to get the ProcessInstanceState corresponding to the given code.

Methods inherited from class org.eclipse.stardust.common.IntKey

compareTo, equals, getKey, getKeys, getName, getValue, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATED

public static final int CREATED

The process instance has just been created.

See Also:

Constant Field Values

ACTIVE

public static final int ACTIVE

The process instance is running.

See Also:

Constant Field Values

ABORTED

public static final int ABORTED

The process instance has been aborted.

See Also:

Constant Field Values

COMPLETED

public static final int COMPLETED

The process instance has been completed.

See Also:

Constant Field Values

INTERRUPTED

public static final int INTERRUPTED

The process instance is interrupted - one of it's activity instances is interrupted.

See Also:

Constant Field Values

ABORTING

public static final int ABORTING

The process instance is in progress of being aborted directly by a user.

See Also:

Constant Field Values

HALTING

public static final int HALTING

The process instance is in progress of being halted directly by a user.

See Also:

Constant Field Values

HALTED

public static final int HALTED

The process instance has been halted.

See Also:

Constant Field Values

Created

public static final ProcessInstanceState Created

Active

public static final ProcessInstanceState Active

Aborted

public static final ProcessInstanceState Aborted

Completed

public static final ProcessInstanceState Completed

Interrupted

public static final ProcessInstanceState Interrupted

Aborting

public static final ProcessInstanceState Aborting

Halting

public static final ProcessInstanceState Halting

Halted

public static final ProcessInstanceState Halted

Method Detail

getAllStates

public static Set<ProcessInstanceState> getAllStates()

Returns:

returns all possible ProcessInstanceState

getState

public static ProcessInstanceState getState(int value)

Factory method to get the ProcessInstanceState corresponding to the given code.

Parameters:

value - one of the ProcessInstanceState codes.

Returns:

one of the predefined ProcessInstanceStates or null if it's an invalid code.