TaskExecutionState (engine-api 9.6.2 API)

java.lang.Object
- java.lang.Enum<TaskExecutionState>
- - com.xebialabs.deployit.engine.api.execution.TaskExecutionState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaskExecutionState>
```
public enum TaskExecutionState
extends java.lang.Enum<TaskExecutionState>
```
All possible values for the execution state of a task.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTED`
`ABORTING`
`CANCELLED`
`CANCELLING`
`DONE`
`EXECUTED`
`EXECUTING`
`FAILED`
`FAILING`
`FORCE_CANCELLED`
`PENDING`
`QUEUED`
`SCHEDULED`
`STOPPED`
`STOPPING`
`UNREGISTERED`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isActive()` If the task is in an active state, the task can go into a different state by itself.
`boolean`	`isExecutingSteps()` Determines if the task is in a state where it is executing steps.
`boolean`	`isExecutionHalted()` Determines if the task has been executing but is halted and can be continued.
`boolean`	`isFinal()` If the task is in a final state, it will never change again to another state.
`boolean`	`isNotBeenExecuting()` Determines if the task is never been executing.
`boolean`	`isPassive()` If the task is in a passive state, the task will not go into a different state by itself.
`boolean`	`isPassiveAfterExecuting()` Determines if the task is passive but it has been executing steps.
`static TaskExecutionState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TaskExecutionState[]`	`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
  - UNREGISTERED
```
public static final TaskExecutionState UNREGISTERED
```
  - PENDING
```
public static final TaskExecutionState PENDING
```
  - SCHEDULED
```
public static final TaskExecutionState SCHEDULED
```
  - QUEUED
```
public static final TaskExecutionState QUEUED
```
  - EXECUTING
```
public static final TaskExecutionState EXECUTING
```
  - FAILING
```
public static final TaskExecutionState FAILING
```
  - FAILED
```
public static final TaskExecutionState FAILED
```
  - STOPPING
```
public static final TaskExecutionState STOPPING
```
  - STOPPED
```
public static final TaskExecutionState STOPPED
```
  - ABORTING
```
public static final TaskExecutionState ABORTING
```
  - ABORTED
```
public static final TaskExecutionState ABORTED
```
  - EXECUTED
```
public static final TaskExecutionState EXECUTED
```
  - DONE
```
public static final TaskExecutionState DONE
```
  - CANCELLED
```
public static final TaskExecutionState CANCELLED
```
  - CANCELLING
```
public static final TaskExecutionState CANCELLING
```
  - FORCE_CANCELLED
```
public static final TaskExecutionState FORCE_CANCELLED
```
- Method Detail
  - values
```
public static TaskExecutionState[] 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 (TaskExecutionState c : TaskExecutionState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TaskExecutionState 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
  - isFinal
```
public boolean isFinal()
```
    If the task is in a final state, it will never change again to another state.
    
    Returns:
    
    true if task is in a final state.
  - isActive
```
public boolean isActive()
```
    If the task is in an active state, the task can go into a different state by itself.
    
    Returns:
    
    true if task is in active state.
  - isPassive
```
public boolean isPassive()
```
    If the task is in a passive state, the task will not go into a different state by itself.
    
    Returns:
    
    true if task is in active state.
  - isExecutingSteps
```
public boolean isExecutingSteps()
```
    Determines if the task is in a state where it is executing steps. This is a subset of isActive()
    
    Returns:
    
    true if task is executing steps
  - isPassiveAfterExecuting
```
public boolean isPassiveAfterExecuting()
```
    Determines if the task is passive but it has been executing steps.
    
    Returns:
    
    true if task is passive after it has been executing steps
  - isExecutionHalted
```
public boolean isExecutionHalted()
```
    Determines if the task has been executing but is halted and can be continued.
    
    Returns:
    
    true if task is halted
  - isNotBeenExecuting
```
public boolean isNotBeenExecuting()
```
    Determines if the task is never been executing.
    
    Returns:
    
    true if the task is never been executing

Enum TaskExecutionState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNREGISTERED

PENDING

SCHEDULED

QUEUED

EXECUTING

FAILING

FAILED

STOPPING

STOPPED

ABORTING

ABORTED

EXECUTED

DONE

CANCELLED

CANCELLING

FORCE_CANCELLED

Method Detail

values

valueOf

isFinal

isActive

isPassive

isExecutingSteps

isPassiveAfterExecuting

isExecutionHalted

isNotBeenExecuting