Work.State (Nuxeo ECM Projects 5.8 API Documentation)

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 a Work instance.
The following transitions between states are possible:
- SCHEDULED -> CANCELED (is never scheduled or run)
- SCHEDULED -> RUNNING
- RUNNING -> COMPLETED
- RUNNING -> FAILED
- RUNNING -> SCHEDULED (is suspended and persisted)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANCELED` Work instance was canceled.
`COMPLETED` Work instance has completed normally.
`FAILED` Work instance has completed with an exception.
`RUNNING` Work instance is running.
`SCHEDULED` Work instance is scheduled to run later.

Method Summary

Methods
Modifier and Type	Method and 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.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SCHEDULED
```
public static final Work.State SCHEDULED
```
    Work instance is scheduled to run later.
  - CANCELED
```
public static final Work.State CANCELED
```
    Work instance was canceled.
    This happens if:
    - it is never scheduled because another instance with the same id was already scheduled or running (when scheduled with WorkManager.Scheduling.IF_NOT_SCHEDULED, WorkManager.Scheduling.IF_NOT_RUNNING, or WorkManager.Scheduling.IF_NOT_RUNNING_OR_SCHEDULED),
    - it is never run because it was scheduled after commit and the transaction rolled back,
    - it is never run because it was scheduled, but another work with the same id was scheduled with WorkManager.Scheduling.CANCEL_SCHEDULED.
  - RUNNING
```
public static final Work.State RUNNING
```
    Work instance is running.
  - COMPLETED
```
public static final Work.State COMPLETED
```
    Work instance has completed normally.
  - FAILED
```
public static final Work.State FAILED
```
    Work instance has completed with an exception.
- 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 name
    
    NullPointerException - if the argument is null

Enum Work.State

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SCHEDULED

CANCELED

RUNNING

COMPLETED

FAILED

Method Detail

values

valueOf