Package org.alfresco.service.cmr.action
Enum ActionStatus
- java.lang.Object
-
- java.lang.Enum<ActionStatus>
-
- org.alfresco.service.cmr.action.ActionStatus
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<ActionStatus>
@AlfrescoPublicApi public enum ActionStatus extends java.lang.Enum<ActionStatus>
The various states an Action can be in.- Author:
- Nick Burch
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CancelledThe Action, which must implementCancellableAction, detected that a cancellation was requested and cancelled itself.CompletedThe Action was run without errorDeclinedThe Action failed with a transient exception.FailedThe Action failed to run to completion.NewA new Action, which has never been runPendingAn Action which has been scheduled for Asynchronous execution, but not yet run.RunningIndicates that the Action is currently being executed by theActionService
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ActionStatusvalueOf(java.io.Serializable s)Returns the enum constant of this type with the specified name.static ActionStatusvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static ActionStatus[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 theActionService
-
Completed
public static final ActionStatus Completed
The Action was run without error
-
Cancelled
public static final ActionStatus Cancelled
The Action, which must implementCancellableAction, detected that a cancellation was requested and cancelled itself.
-
Failed
public static final ActionStatus Failed
The Action failed to run to completion. CallAction.getExecutionFailureMessage()to find out why.
-
Declined
public static final ActionStatus Declined
The Action failed with a transient exception. CallAction.getExecutionFailureMessage()to find out why.- Since:
- 4.0.1
-
-
Method Detail
-
values
public static ActionStatus[] 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 (ActionStatus c : ActionStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ActionStatus 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 namejava.lang.NullPointerException- if the argument is null
-
valueOf
public static ActionStatus valueOf(java.io.Serializable s)
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:
s- 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 namejava.lang.NullPointerException- if the argument is null
-
-