Content Engine Java API: TaskState

java.lang.Object
- com.filenet.api.constants.TaskState

All Implemented Interfaces:

java.io.Serializable
```
public final class TaskState
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that identify the states of a CmTask object. For a complete description of each state, see Task State Machine.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TaskState`	`COMPLETE` Indicates that the task has been successfully completed.
`static int`	`COMPLETE_AS_INT` An `int` value associated with the COMPLETE instance of this class.
`static TaskState`	`FAILED` Indicates that execution of the task failed.
`static int`	`FAILED_AS_INT` An `int` value associated with the FAILED instance of this class.
`static TaskState`	`READY` Indicates that the task is no longer blocked either by predecessors that have not completed or by a precondition, and, therefore, it is ready to be worked on.
`static int`	`READY_AS_INT` An `int` value associated with the READY instance of this class.
`static TaskState`	`WAITING_ALL` Indicates that the task is blocked by both incomplete predecessors and an unsatisfied precondition.
`static int`	`WAITING_ALL_AS_INT` An `int` value associated with the WAITING_ALL instance of this class.
`static TaskState`	`WAITING_PRECONDITION` Indicates that the task is yet to satisfy its precondition, but is not blocked by any incomplete predecessors.
`static int`	`WAITING_PRECONDITION_AS_INT` An `int` value associated with the WAITING_PRECONDITION instance of this class.
`static TaskState`	`WAITING_PREDECESSORS` Indicates that the task has satisfied its precondition but is blocked by incomplete predecessors.
`static int`	`WAITING_PREDECESSORS_AS_INT` An `int` value associated with the WAITING_PREDECESSORS instance of this class.
`static TaskState`	`WORKING` Indicates that the task is being actively worked on.
`static int`	`WORKING_AS_INT` An `int` value associated with the WORKING instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static TaskState`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

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

- Field Detail
  - COMPLETE_AS_INT
```
public static final int COMPLETE_AS_INT
```
    An int value associated with the COMPLETE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - COMPLETE
```
public static final TaskState COMPLETE
```
    Indicates that the task has been successfully completed.
  - WORKING_AS_INT
```
public static final int WORKING_AS_INT
```
    An int value associated with the WORKING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - WORKING
```
public static final TaskState WORKING
```
    Indicates that the task is being actively worked on.
  - WAITING_ALL_AS_INT
```
public static final int WAITING_ALL_AS_INT
```
    An int value associated with the WAITING_ALL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - WAITING_ALL
```
public static final TaskState WAITING_ALL
```
    Indicates that the task is blocked by both incomplete predecessors and an unsatisfied precondition.
  - FAILED_AS_INT
```
public static final int FAILED_AS_INT
```
    An int value associated with the FAILED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - FAILED
```
public static final TaskState FAILED
```
    Indicates that execution of the task failed.
  - READY_AS_INT
```
public static final int READY_AS_INT
```
    An int value associated with the READY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - READY
```
public static final TaskState READY
```
    Indicates that the task is no longer blocked either by predecessors that have not completed or by a precondition, and, therefore, it is ready to be worked on.
  - WAITING_PRECONDITION_AS_INT
```
public static final int WAITING_PRECONDITION_AS_INT
```
    An int value associated with the WAITING_PRECONDITION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - WAITING_PRECONDITION
```
public static final TaskState WAITING_PRECONDITION
```
    Indicates that the task is yet to satisfy its precondition, but is not blocked by any incomplete predecessors. This is the initial state for all newly created CmTask instances.
  - WAITING_PREDECESSORS_AS_INT
```
public static final int WAITING_PREDECESSORS_AS_INT
```
    An int value associated with the WAITING_PREDECESSORS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - WAITING_PREDECESSORS
```
public static final TaskState WAITING_PREDECESSORS
```
    Indicates that the task has satisfied its precondition but is blocked by incomplete predecessors.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static TaskState getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

COMPLETE_AS_INT

COMPLETE

WORKING_AS_INT

WORKING

WAITING_ALL_AS_INT

WAITING_ALL

FAILED_AS_INT

FAILED

READY_AS_INT

READY

WAITING_PRECONDITION_AS_INT

WAITING_PRECONDITION

WAITING_PREDECESSORS_AS_INT

WAITING_PREDECESSORS

getValue

toString

getInstanceFromInt