Package org.alfresco.service.cmr.action

Enum Class ActionStatus

java.lang.Object

java.lang.Enum<ActionStatus>

org.alfresco.service.cmr.action.ActionStatus

All Implemented Interfaces:

Serializable, Comparable<ActionStatus>, Constable

@AlfrescoPublicApi
public enum ActionStatus
extends Enum<ActionStatus>

The various states an Action can be in.

Author:

Nick Burch

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
Cancelled	The Action, which must implement CancellableAction, detected that a cancellation was requested and cancelled itself.
Completed	The Action was run without error
Declined	The Action failed with a transient exception.
Failed	The Action failed to run to completion.
New	A new Action, which has never been run
Pending	An Action which has been scheduled for Asynchronous execution, but not yet run.
Running	Indicates that the Action is currently being executed by the ActionService

Method Summary

Modifier and Type	Method	Description
static ActionStatus	valueOf(Serializable s)	Returns the enum constant of this class with the specified name.
static ActionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActionStatus[]	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

New

public static final ActionStatus New

A new Action, which has never been run

Pending

public static final ActionStatus Pending

An Action which has been scheduled for Asynchronous execution, but not yet run.

Running

public static final ActionStatus Running

Indicates that the Action is currently being executed by the ActionService

Completed

public static final ActionStatus Completed

The Action was run without error

Cancelled

public static final ActionStatus Cancelled

The Action, which must implement CancellableAction, detected that a cancellation was requested and cancelled itself.

Failed

public static final ActionStatus Failed

The Action failed to run to completion. Call Action.getExecutionFailureMessage() to find out why.

Declined

public static final ActionStatus Declined

The Action failed with a transient exception. Call Action.getExecutionFailureMessage() to find out why.

Since:

4.0.1

Method Details

values

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

valueOf

public static ActionStatus valueOf(Serializable s)

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:

s - 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