Package org.nuxeo.ecm.core.bulk.message

Enum Class BulkStatus.State

java.lang.Object

java.lang.Enum<BulkStatus.State>

org.nuxeo.ecm.core.bulk.message.BulkStatus.State

All Implemented Interfaces:

Serializable, Comparable<BulkStatus.State>, Constable

Enclosing class:

BulkStatus

public static enum BulkStatus.State
extends Enum<BulkStatus.State>

Possible states of a bulk command:

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	The command has been aborted, the action might have been partially applied on the document set.
COMPLETED	The action has been applied to the document set, the command is completed.
RUNNING	The scroller has terminated, the size of the document set is known and action is applied.
SCHEDULED	The command has been submitted to the service.
SCROLLING_RUNNING	The scroller is running and materialize the document set.
UNKNOWN	The command or the status is unknown.

Method Summary

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

UNKNOWN

public static final BulkStatus.State UNKNOWN

The command or the status is unknown.

SCHEDULED

public static final BulkStatus.State SCHEDULED

The command has been submitted to the service.

SCROLLING_RUNNING

public static final BulkStatus.State SCROLLING_RUNNING

The scroller is running and materialize the document set.

RUNNING

public static final BulkStatus.State RUNNING

The scroller has terminated, the size of the document set is known and action is applied.

COMPLETED

public static final BulkStatus.State COMPLETED

The action has been applied to the document set, the command is completed.

ABORTED

public static final BulkStatus.State ABORTED

The command has been aborted, the action might have been partially applied on the document set.

Method Details

values

public static BulkStatus.State[] 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 BulkStatus.State 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