com.evolveum.midpoint.task.api

Enum TaskExecutionStatus

java.lang.Object

java.lang.Enum<TaskExecutionStatus>

com.evolveum.midpoint.task.api.TaskExecutionStatus

All Implemented Interfaces:

Serializable, Comparable<TaskExecutionStatus>

public enum TaskExecutionStatus
extends Enum<TaskExecutionStatus>

Task execution status. Execution status provides information about the task overall high-level execution state. It tells whether the task is running/runnable, waits for something or is done.

Author:

Radovan Semancik

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED The task is done.
RUNNABLE The task is running or is ready to be executed.
SUSPENDED The task has been suspended.
WAITING The IDM system is waiting while the task is being executed on an external node (e.g.

Method Summary

Methods

Modifier and Type	Method and Description
static TaskExecutionStatus	fromTaskType(com.evolveum.midpoint.xml.ns._public.common.common_3.TaskExecutionStatusType executionStatus)
com.evolveum.midpoint.xml.ns._public.common.common_3.TaskExecutionStatusType	toTaskType()
static TaskExecutionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static TaskExecutionStatus[]	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

RUNNABLE

public static final TaskExecutionStatus RUNNABLE

The task is running or is ready to be executed. This state implies that the task is being actively executed by IDM nodes, e.g. there is a thread on one of the IDM nodes that executes the task or the system needs to allocate such thread.

WAITING

public static final TaskExecutionStatus WAITING

The IDM system is waiting while the task is being executed on an external node (e.g. external workflow engine) or is waiting for some kind of external signal (e.g. approval in internal workflow). The task may be running on external node or blocked on IDM node. One way or another, there is no point in allocating a thread to run this task. Other task properties provide more information about the actual "business" state of the task.

SUSPENDED

public static final TaskExecutionStatus SUSPENDED

The task has been suspended. It waits until an instruction to resume it arrives. After that, it will (usually) go to the RUNNABLE state again. Or, it can be closed in the suspended state as well. If a task that is currently executing (i.e. claimed) is suspended, it will first be in SUSPENDED/CLAIMED state, until its handler finishes the execution. After that, it will go into SUSPENDED/RELEASED state, where it will remain until resumed.

CLOSED

public static final TaskExecutionStatus CLOSED

The task is done. No other changes or progress will happen. The task in this state is considered immutable and the only things that can happen to it is a delete by a cleanup code.

Method Detail

values

public static TaskExecutionStatus[] 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 (TaskExecutionStatus c : TaskExecutionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static TaskExecutionStatus 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

fromTaskType

public static TaskExecutionStatus fromTaskType(com.evolveum.midpoint.xml.ns._public.common.common_3.TaskExecutionStatusType executionStatus)

toTaskType

public com.evolveum.midpoint.xml.ns._public.common.common_3.TaskExecutionStatusType toTaskType()