org.nuxeo.ecm.platform.routing.api

Enum DocumentRoutingConstants.Events

java.lang.Object

java.lang.Enum<DocumentRoutingConstants.Events>

org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants.Events

All Implemented Interfaces:

Serializable, Comparable<DocumentRoutingConstants.Events>

Enclosing interface:

DocumentRoutingConstants

public static enum DocumentRoutingConstants.Events
extends Enum<DocumentRoutingConstants.Events>

Enum Constant Summary

Enum Constants

Enum Constant and Description
afterRouteFinish after the route is finished.
afterRouteReady after the route is ready, each part of the route is in "Ready" state.The session used is unrestricted.
afterRouteValidated after the route is validated, each part of the route is in "Validated" state.
afterStepBackToReady after a step was put back to ready state.
afterStepRunning after the operation chain for this step is called.The step is in "Done" state.The session used is unrestricted.
afterUndoingStep after the undo operation is run on the step.
beforeRouteReady before the route is ready, each part of the route is in "Validated" state.The session used is unrestricted.
beforeRouteStart before the route starts.
beforeRouteValidated before the route is validated, each part of the route is in "Draft" state.
beforeStepBackToReady before a step is put back to ready state.
beforeStepRunning before the operation chain for this step is called.
beforeUndoingStep before the undo operation is run on the step.
stepWaiting After the operation chain of this step ran and if the step is not done, ie: if we are in a waiting state.The session used is unrestricted.
workflowCanceled

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

beforeRouteValidated

public static final DocumentRoutingConstants.Events beforeRouteValidated

before the route is validated, each part of the route is in "Draft" state. The session used is unrestricted. The element key is the route.

afterRouteValidated

public static final DocumentRoutingConstants.Events afterRouteValidated

after the route is validated, each part of the route is in "Validated" state. The session used is unrestricted. The element key is the route.

beforeRouteReady

public static final DocumentRoutingConstants.Events beforeRouteReady

before the route is ready, each part of the route is in "Validated" state.The session used is unrestricted. The element key is the route.

afterRouteReady

public static final DocumentRoutingConstants.Events afterRouteReady

after the route is ready, each part of the route is in "Ready" state.The session used is unrestricted. The element key is the route.

beforeRouteStart

public static final DocumentRoutingConstants.Events beforeRouteStart

before the route starts. The RouteDocument is in "Running" state, other parts of the route is either in Ready, Running or Done state.The session used is unrestricted. The element key is the route.

afterRouteFinish

public static final DocumentRoutingConstants.Events afterRouteFinish

after the route is finished. The route and each part of the route is in Done state.The session used is unrestricted. The element key is the route.

beforeStepRunning

public static final DocumentRoutingConstants.Events beforeStepRunning

before the operation chain for this step is called. The step is in "Running" state.The session used is unrestricted. The element key is the step.

stepWaiting

public static final DocumentRoutingConstants.Events stepWaiting

After the operation chain of this step ran and if the step is not done, ie: if we are in a waiting state.The session used is unrestricted. The element key is the step.

afterStepRunning

public static final DocumentRoutingConstants.Events afterStepRunning

after the operation chain for this step is called.The step is in "Done" state.The session used is unrestricted. The element key is the step.

beforeStepBackToReady

public static final DocumentRoutingConstants.Events beforeStepBackToReady

before a step is put back to ready state.

afterStepBackToReady

public static final DocumentRoutingConstants.Events afterStepBackToReady

after a step was put back to ready state.

beforeUndoingStep

public static final DocumentRoutingConstants.Events beforeUndoingStep

before the undo operation is run on the step.

afterUndoingStep

public static final DocumentRoutingConstants.Events afterUndoingStep

after the undo operation is run on the step.

workflowCanceled

public static final DocumentRoutingConstants.Events workflowCanceled

Since:

2.7.2

Method Detail

values

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

Returns:

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

valueOf

public static DocumentRoutingConstants.Events 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