org.alfresco.repo.action.scheduled

Enum AbstractScheduledAction.CompensatingActionMode

java.lang.Object

java.lang.Enum<AbstractScheduledAction.CompensatingActionMode>

org.alfresco.repo.action.scheduled.AbstractScheduledAction.CompensatingActionMode

All Implemented Interfaces:

Serializable, Comparable<AbstractScheduledAction.CompensatingActionMode>

Enclosing class:

AbstractScheduledAction

public static enum AbstractScheduledAction.CompensatingActionMode
extends Enum<AbstractScheduledAction.CompensatingActionMode>

Enum to define if compensating actions are run.

Author:

Andy Hind

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE Ignore compensating actions
RUN_COMPENSATING_ACTIONS_ON_FAILURE If failure occurs run the comensating actions.

Method Summary

Modifier and Type	Method and Description
static AbstractScheduledAction.CompensatingActionMode	getCompensatingActionMode(String compensatingActionModeString) Parse a string to a compensating action mode - used in reading the config.
static AbstractScheduledAction.CompensatingActionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AbstractScheduledAction.CompensatingActionMode[]	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

RUN_COMPENSATING_ACTIONS_ON_FAILURE

public static final AbstractScheduledAction.CompensatingActionMode RUN_COMPENSATING_ACTIONS_ON_FAILURE

If failure occurs run the comensating actions.

IGNORE

public static final AbstractScheduledAction.CompensatingActionMode IGNORE

Ignore compensating actions

Method Detail

values

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

Returns:

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

valueOf

public static AbstractScheduledAction.CompensatingActionMode 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

getCompensatingActionMode

public static AbstractScheduledAction.CompensatingActionMode getCompensatingActionMode(String compensatingActionModeString)

Parse a string to a compensating action mode - used in reading the config.

Parameters:

compensatingActionModeString - String

Returns:

- the compensating action mode.