Package org.openwms.tms

Enum Class TransportOrderState

java.lang.Object

java.lang.Enum<TransportOrderState>

org.openwms.tms.TransportOrderState

All Implemented Interfaces:

Serializable, Comparable<TransportOrderState>, Constable

public enum TransportOrderState
extends Enum<TransportOrderState>

A TransportOrderState defines all possible states a TransportOrder may resist in.

Author:

Heiko Scherrer

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
CANCELED	Status of a aborted TransportOrder.
CREATED	Status of new created TransportOrders.
FINISHED	Status to indicate that the TransportOrder completed successfully.
INITIALIZED	Status of a full initialized TransportOrder, ready to be started.
INTERRUPTED	Status to indicate that the TransportOrder is paused.
ONFAILURE	Status to indicate a failure on the TransportOrder.
STARTED	A started and activeTransportOrder, ready to be executed.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	order

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TransportOrderState(int sortOrder)

Method Summary

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

CREATED

public static final TransportOrderState CREATED

Status of new created TransportOrders.

INITIALIZED

public static final TransportOrderState INITIALIZED

Status of a full initialized TransportOrder, ready to be started.

STARTED

public static final TransportOrderState STARTED

A started and activeTransportOrder, ready to be executed.

INTERRUPTED

public static final TransportOrderState INTERRUPTED

Status to indicate that the TransportOrder is paused. Not active anymore.

ONFAILURE

public static final TransportOrderState ONFAILURE

Status to indicate a failure on the TransportOrder. Not active anymore.

CANCELED

public static final TransportOrderState CANCELED

Status of a aborted TransportOrder. Not active anymore.

FINISHED

public static final TransportOrderState FINISHED

Status to indicate that the TransportOrder completed successfully.

Field Details

order

private final int order

Constructor Details

TransportOrderState

private TransportOrderState(int sortOrder)

Method Details

values

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

getOrder

public int getOrder()

Get the order.

Returns:

the order.