Package org.openwms.wms.receiving.api

Enum Class OrderState

java.lang.Object

java.lang.Enum<OrderState>

org.openwms.wms.receiving.api.OrderState

All Implemented Interfaces:

Serializable, Comparable<OrderState>, Constable

public enum OrderState
extends Enum<OrderState>

An OrderState is used to define the state of a ReceivingOrder or ReceivingOrderPosition.

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	If the Order or Position has been cancelled.
COMPLETED	Order or Position has been completed successfully.
CREATED	When the Order has been created.
PARTIALLY_COMPLETED	Order has been completed only partially, the unfulfilled positions can be transferred to a new order.
PROCESSING	When the Order is currently in the process of capturing.
UNDEFINED	Initial state.
VALIDATED	After creation, if all position have been validated successfully.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OrderState()

Method Summary

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

UNDEFINED

public static final OrderState UNDEFINED

Initial state.

CREATED

public static final OrderState CREATED

When the Order has been created.

VALIDATED

public static final OrderState VALIDATED

After creation, if all position have been validated successfully.

PROCESSING

public static final OrderState PROCESSING

When the Order is currently in the process of capturing.

CANCELED

public static final OrderState CANCELED

If the Order or Position has been cancelled.

PARTIALLY_COMPLETED

public static final OrderState PARTIALLY_COMPLETED

Order has been completed only partially, the unfulfilled positions can be transferred to a new order.

COMPLETED

public static final OrderState COMPLETED

Order or Position has been completed successfully.

Constructor Details

OrderState

private OrderState()

Method Details

values

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