Package com.evolveum.midpoint.repo.common.activity

Enum Class ActivityRunResultStatus

java.lang.Object

java.lang.Enum<ActivityRunResultStatus>

com.evolveum.midpoint.repo.common.activity.ActivityRunResultStatus

All Implemented Interfaces:

Serializable, Comparable<ActivityRunResultStatus>, Constable

public enum ActivityRunResultStatus
extends Enum<ActivityRunResultStatus>

Result status of an activity run. Besides providing the success or failure status (with severity), it also indicates the nature of the failure (if any) - whether it is permanent or temporary, whether the activity should be restarted, etc. Derived from TaskRunResult.TaskRunResultStatus, but separated to make the distinction between task and activity clearer. Many activity result statuses directly map to task result statuses, but some are activity-specific. NOTE: We are still not entirely sure about the set of statuses and their semantics. Even the name of this class is not ideal, because it collides with OperationResultStatus. So this is subject to change.

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
ABORTED	Situation (typically an error) that makes activity abort, i.e., definitely stop its execution, without an option of continuing.
FINISHED	Activity is not meant to run again, and no special action from neither activity framework nor task engine is needed.
HALTING_ERROR
INTERRUPTED	The activity run cannot continue now, because the enclosing task was interrupted (e.g. by suspending it or by shutting down the system).
PERMANENT_ERROR
RESTART_REQUESTED	When an activity has to be restarted (because of a policy rule), it is marked as aborted with a pending restart, and then the enclosing task run result is set to TaskRunResult.TaskRunResultStatus.RESTART_REQUESTED.
TEMPORARY_ERROR
WAITING	The activity run cannot continue now, but it is expected to continue later - after dependent task(s) finish.

Method Summary

Modifier and Type	Method	Description
@Nullable TaskRunResult.TaskRunResultStatus	toTaskRunResultStatus()
static ActivityRunResultStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActivityRunResultStatus[]	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 ActivityRunResultStatus FINISHED

Activity is not meant to run again, and no special action from neither activity framework nor task engine is needed. The activity itself may be completed or aborted.

See Also:

• TaskRunResult.TaskRunResultStatus.FINISHED

PERMANENT_ERROR

public static final ActivityRunResultStatus PERMANENT_ERROR

See Also:

• TaskRunResult.TaskRunResultStatus.PERMANENT_ERROR

TEMPORARY_ERROR

public static final ActivityRunResultStatus TEMPORARY_ERROR

See Also:

• TaskRunResult.TaskRunResultStatus.TEMPORARY_ERROR

HALTING_ERROR

public static final ActivityRunResultStatus HALTING_ERROR

See Also:

• TaskRunResult.TaskRunResultStatus.HALTING_ERROR

ABORTED

public static final ActivityRunResultStatus ABORTED

Situation (typically an error) that makes activity abort, i.e., definitely stop its execution, without an option of continuing. The activity can be either skipped or restarted (later). There's no mapping to TaskRunResult.TaskRunResultStatus, because there's nontrivial logic deciding between TaskRunResult.TaskRunResultStatus.FINISHED and TaskRunResult.TaskRunResultStatus.RESTART_REQUESTED.

RESTART_REQUESTED

public static final ActivityRunResultStatus RESTART_REQUESTED

When an activity has to be restarted (because of a policy rule), it is marked as aborted with a pending restart, and then the enclosing task run result is set to TaskRunResult.TaskRunResultStatus.RESTART_REQUESTED. However, it there are intermediate activities that go to the task boundary, they must be stepped out first. This status is used to do that.

INTERRUPTED

public static final ActivityRunResultStatus INTERRUPTED

The activity run cannot continue now, because the enclosing task was interrupted (e.g. by suspending it or by shutting down the system).

See Also:

• TaskRunResult.TaskRunResultStatus.INTERRUPTED

WAITING

public static final ActivityRunResultStatus WAITING

The activity run cannot continue now, but it is expected to continue later - after dependent task(s) finish. The enclosing task should go into WAITING state. Used mainly for delegated and distributed activities, where we need to the subtask(s) to finish first.

See Also:

• TaskRunResult.TaskRunResultStatus.WAITING

Method Details

values

public static ActivityRunResultStatus[] 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 ActivityRunResultStatus 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

toTaskRunResultStatus

@Nullable
public @Nullable TaskRunResult.TaskRunResultStatus toTaskRunResultStatus()