de.hybris.platform.workflow

Enum WorkflowStatus

java.lang.Object

java.lang.Enum<WorkflowStatus>

de.hybris.platform.workflow.WorkflowStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WorkflowStatus>

public enum WorkflowStatus
extends java.lang.Enum<WorkflowStatus>

Each WorkflowModel can exist in four states:

• planned - workflow created, but not started yet Running
• running - in progress
• terminated - workflow was in progress but it has interrupted for some reason
• finished - workflow is done

WorkflowStatus is interpreted as a counter part for a WorkflowService.isPlanned(WorkflowModel), WorkflowService.isRunning(WorkflowModel), WorkflowService.isFinished(WorkflowModel), WorkflowService.isTerminated(WorkflowModel) to check what is the current state of the WorkflowModel. WorkflowStatus is used as additional criteria to fetch WorkflowModel for more than one strict status within WorkflowService.getAllAdhocWorkflows(EnumSet, java.util.Date, java.util.Date) and WorkflowService.getAllWorkflows(EnumSet, java.util.Date, java.util.Date).

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED
PLANNED
RUNNING
TERMINATED

Method Summary

Modifier and Type	Method and Description
static java.util.EnumSet<WorkflowStatus>	getAll()
static WorkflowStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WorkflowStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLANNED

public static final WorkflowStatus PLANNED

RUNNING

public static final WorkflowStatus RUNNING

FINISHED

public static final WorkflowStatus FINISHED

TERMINATED

public static final WorkflowStatus TERMINATED

Method Detail

values

public static WorkflowStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WorkflowStatus c : WorkflowStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static WorkflowStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAll

public static java.util.EnumSet<WorkflowStatus> getAll()