Package com.evolveum.midpoint.task.api

Enum Class TaskRunResult.TaskRunResultStatus

java.lang.Object

java.lang.Enum<TaskRunResult.TaskRunResultStatus>

com.evolveum.midpoint.task.api.TaskRunResult.TaskRunResultStatus

All Implemented Interfaces:

Serializable, Comparable<TaskRunResult.TaskRunResultStatus>, Constable

Enclosing class:

TaskRunResult

public static enum TaskRunResult.TaskRunResultStatus
extends Enum<TaskRunResult.TaskRunResultStatus>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FINISHED	The task run has finished.
HALTING_ERROR	Like PERMANENT_ERROR, but in addition, task and its dependent tasks (parent, grand-parent, ..., plus explicit dependents) are going to be suspended.
INTERRUPTED	Task run hasn't finished, but nevertheless it must end (for now).
PERMANENT_ERROR	The run has failed.
RESTART_REQUESTED	Like HALTING_ERROR, but in addition, the whole task tree should be restarted.
TEMPORARY_ERROR	Temporary failure during the run.
WAITING	Task run hasn't finished, but it should go to WAITING state.

Method Summary

Modifier and Type	Method	Description
static TaskRunResult.TaskRunResultStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaskRunResult.TaskRunResultStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FINISHED

public static final TaskRunResult.TaskRunResultStatus FINISHED

The task run has finished. This does not necessarily mean that the task itself is going to be closed. While single-run tasks are, recurring ones will run again later.

PERMANENT_ERROR

public static final TaskRunResult.TaskRunResultStatus PERMANENT_ERROR

The run has failed. The error is permanent. Unless the administrator does something to recover from the situation, there is no point in re-trying the run. The usual case of this error is task misconfiguration.

TEMPORARY_ERROR

public static final TaskRunResult.TaskRunResultStatus TEMPORARY_ERROR

Temporary failure during the run. The error is temporary. The situation may change later when the conditions will be more favorable. It makes sense to retry the run. Usual cases of this error are network timeouts. For single-run tasks we suspend them on such occasions. So the administrator can resume them after correcting the problem.

HALTING_ERROR

public static final TaskRunResult.TaskRunResultStatus HALTING_ERROR

Like PERMANENT_ERROR, but in addition, task and its dependent tasks (parent, grand-parent, ..., plus explicit dependents) are going to be suspended. In fact, this halts the whole task tree. Currently used when handling policy actions that suspend tasks.

RESTART_REQUESTED

public static final TaskRunResult.TaskRunResultStatus RESTART_REQUESTED

Like HALTING_ERROR, but in addition, the whole task tree should be restarted. The TaskRunResult.taskRestartInstruction can provide additional instructions, like the delay before restart.

INTERRUPTED

public static final TaskRunResult.TaskRunResultStatus INTERRUPTED

Task run hasn't finished, but nevertheless it must end (for now). An example of such a situation is when a task execution is requested to stop, e.g., when suspending the task or shutting down the node.

WAITING

public static final TaskRunResult.TaskRunResultStatus WAITING

Task run hasn't finished, but it should go to WAITING state. Typical example is when a task delegated the work to its subtasks and now it is waiting for their completion.

Method Details

values

public static TaskRunResult.TaskRunResultStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TaskRunResult.TaskRunResultStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null