Package org.nuxeo.ecm.core.work.api
Enum Work.State
- java.lang.Object
-
- java.lang.Enum<Work.State>
-
- org.nuxeo.ecm.core.work.api.Work.State
-
- All Implemented Interfaces:
Serializable
,Comparable<Work.State>
- Enclosing interface:
- Work
public static enum Work.State extends Enum<Work.State>
The running state of aWork
instance.The following transitions between states are possible:
- UNKNOWN -> SCHEDULED (unknown from the manager point of view)
- SCHEDULED -> CANCELED (is never scheduled or run)
- SCHEDULED -> RUNNING
- RUNNING -> COMPLETED
- RUNNING -> FAILED
- RUNNING -> SCHEDULED (is suspended and persisted)
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Work.State
valueOf(String name)
Returns the enum constant of this type with the specified name.static Work.State[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNKNOWN
public static final Work.State UNKNOWN
Work instance is not currently referenced in work manager- Since:
- 5.9.4
-
SCHEDULED
public static final Work.State SCHEDULED
Work instance is scheduled to run later.
-
RUNNING
public static final Work.State RUNNING
Work instance is running.
-
-
Method Detail
-
values
public static Work.State[] 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 (Work.State c : Work.State.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Work.State valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-