OrderStatus (stumps 1.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<OrderStatus>
- - com.neurosys.ecom.orders.domain.OrderStatus

All Implemented Interfaces:

FlowStatus, Serializable, Comparable<OrderStatus>
```
public enum OrderStatus
extends Enum<OrderStatus>
implements FlowStatus
```
Status of the Order

Author:

Arjun Dhar

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPROVED` An optional state in a workflow, where before it an be PLACED or IN_PROCESS or REMIND_USER_TO_PROCEED it is in an APPROVED state ready to be processed.
`BACK_ORDER` If an order was requested but was still accepted inspite of zero inventory.
`CANCELLED_ADMIN` The order was cancelled by an Admin on the merchant side, irrespective of user getting the order or not.
`CANCELLED_SYSTEM` The order was cancelled by the system, due to some System related rule failing
`CANCELLED_USER` The order was cancelled by the user irrespective of user getting the order or not.
`CAPTURED_AUTO` This is an step before `PLACED_AUTO`; where after an online payment some gateways allow you to CAPTURE the payment.
`CAPTURED_MANUAL` This is an step before `PLACED_MANUAL`; where after an online payment some gateways allow you to CAPTURE the payment. This can be followed by a `PLACED_MANUAL` or `PLACED_AUTO`
`CLAIM_REFUND` The entity has claimed a refund after `RETURNED` or `OrderStatus#CANCELLED`
`CLOSED` The order has been fulfilled or reverted and been closed
`DELIVERED` The order reached the entity
`DISPATCHED` The order has been dispatched to the entity
`DISPUTE` The order status is complicated and under dispute
`FAILED_TRANSACTION_COMPLETE` The order failed during a transaction due to inability of the user to complete the required steps of payment or ordering.
`FAILED_TRANSACTION_ERROR` The order failed due to some error or external circumstances.
`IN_PROCESS` After the order was REQUESTED; it is being validated and is in Process IN_PROCESS differs from ON_HOLD in the sense that IN_PROCESS there is progress in the natural course.
`OFFLINE` All aspects of the order are now not online and maintained by another system or offline
`ON_HOLD` The Order is stuck, or waiting for approval or some signal to proceed.
`PLACED_AUTO` Payment was confirmed & placed.
`PLACED_MANUAL` Payment was confirmed & placed.
`PLACED_PARTIAL` Was placed online but for some reason the placement could not be completed online and the same. Order was then completed in an offline manner.
`READY` Service based Orders, may need to communicate Ready to deliver State.
`REFUND` The entity was sent a refund
`REMIND_USER_TO_PROCEED` If an Order requires a user to take the next step or perform an action then this status should be used.
`REQUESTED` The entity placed/requested an Order; this has not been realized nor paid or processed.
`RETURNED` The order was rejected/returned by the entity after it was delivered

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static OrderStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OrderStatus[]`	`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

Methods inherited from interface com.neurosys.workflow.domain.FlowStatus
name, ordinal

- Enum Constant Detail
  - REQUESTED
```
public static final OrderStatus REQUESTED
```
    The entity placed/requested an Order; this has not been realized nor paid or processed. Its just in a RAW placed state.
    If placed by a USER it could imply an order was initiated but not compeleted.
    If placed by an Admin/System then it implies the Order is yet to be Approved or paid for.
  - APPROVED
```
public static final OrderStatus APPROVED
```
    An optional state in a workflow, where before it an be PLACED or IN_PROCESS or REMIND_USER_TO_PROCEED it is in an APPROVED state ready to be processed.
    An alternative state can be ON_HOLD or one of the CANCELLED states, which signal it was rejected.
  - FAILED_TRANSACTION_COMPLETE
```
public static final OrderStatus FAILED_TRANSACTION_COMPLETE
```
    The order failed during a transaction due to inability of the user to complete the required steps of payment or ordering.
  - FAILED_TRANSACTION_ERROR
```
public static final OrderStatus FAILED_TRANSACTION_ERROR
```
    The order failed due to some error or external circumstances. It could also be FAILED_COMPLETE but if we cannot tell for sure then we should mark it as FAILED_ERROR.
  - IN_PROCESS
```
public static final OrderStatus IN_PROCESS
```
    After the order was REQUESTED; it is being validated and is in Process
    IN_PROCESS differs from ON_HOLD in the sense that IN_PROCESS there is progress in the natural course. ON_HOLD explicitly states its not in progress.
  - PLACED_AUTO
```
public static final OrderStatus PLACED_AUTO
```
    Payment was confirmed & placed. The Order is now in progress to be sent to the requesting entity (Customer)
    Placed as a result of some confirmed steps in accordance to System rules.
  - PLACED_PARTIAL
```
public static final OrderStatus PLACED_PARTIAL
```
    Was placed online but for some reason the placement could not be completed online and the same.
    Order was then completed in an offline manner.
  - PLACED_MANUAL
```
public static final OrderStatus PLACED_MANUAL
```
    Payment was confirmed & placed. The Order is now in progress to be sent to the requesting entity (Customer)
    Placed as a result of manual/admin confirmation.
  - DISPATCHED
```
public static final OrderStatus DISPATCHED
```
    The order has been dispatched to the entity
  - DELIVERED
```
public static final OrderStatus DELIVERED
```
    The order reached the entity
  - RETURNED
```
public static final OrderStatus RETURNED
```
    The order was rejected/returned by the entity after it was delivered
  - CANCELLED_USER
```
public static final OrderStatus CANCELLED_USER
```
    The order was cancelled by the user irrespective of user getting the order or not.
  - CANCELLED_ADMIN
```
public static final OrderStatus CANCELLED_ADMIN
```
    The order was cancelled by an Admin on the merchant side, irrespective of user getting the order or not.
    This can be a REJECT in a workflow where for any reason the Admin did not want the order to proceed.
  - CANCELLED_SYSTEM
```
public static final OrderStatus CANCELLED_SYSTEM
```
    The order was cancelled by the system, due to some System related rule failing
  - CLAIM_REFUND
```
public static final OrderStatus CLAIM_REFUND
```
    The entity has claimed a refund after RETURNED or OrderStatus#CANCELLED
  - REFUND
```
public static final OrderStatus REFUND
```
    The entity was sent a refund
  - DISPUTE
```
public static final OrderStatus DISPUTE
```
    The order status is complicated and under dispute
  - CLOSED
```
public static final OrderStatus CLOSED
```
    The order has been fulfilled or reverted and been closed
  - OFFLINE
```
public static final OrderStatus OFFLINE
```
    All aspects of the order are now not online and maintained by another system or offline
  - REMIND_USER_TO_PROCEED
```
public static final OrderStatus REMIND_USER_TO_PROCEED
```
    If an Order requires a user to take the next step or perform an action then this status should be used.
  - CAPTURED_AUTO
```
public static final OrderStatus CAPTURED_AUTO
```
    This is an step before PLACED_AUTO; where after an online payment some gateways allow you to CAPTURE the payment.
    This can be followed by a PLACED_MANUAL or PLACED_AUTO
  - CAPTURED_MANUAL
```
public static final OrderStatus CAPTURED_MANUAL
```
    This is an step before PLACED_MANUAL; where after an online payment some gateways allow you to CAPTURE the payment.
    This can be followed by a PLACED_MANUAL or PLACED_AUTO
  - ON_HOLD
```
public static final OrderStatus ON_HOLD
```
    The Order is stuck, or waiting for approval or some signal to proceed.
    IN_PROCESS differs from ON_HOLD in the sense that IN_PROCESS there is progress in the natural course. ON_HOLD explicitly states its not in progress.
  - READY
```
public static final OrderStatus READY
```
    Service based Orders, may need to communicate Ready to deliver State. Pre-Delivery
  - BACK_ORDER
```
public static final OrderStatus BACK_ORDER
```
    If an order was requested but was still accepted inspite of zero inventory. Then as a Back Order accept to provide it to the customer.
- Method Detail
  - values
```
public static OrderStatus[] 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 (OrderStatus c : OrderStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OrderStatus 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

Enum OrderStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.neurosys.workflow.domain.FlowStatus

Enum Constant Detail

REQUESTED

APPROVED

FAILED_TRANSACTION_COMPLETE

FAILED_TRANSACTION_ERROR

IN_PROCESS

PLACED_AUTO

PLACED_PARTIAL

PLACED_MANUAL

DISPATCHED

DELIVERED

RETURNED

CANCELLED_USER

CANCELLED_ADMIN

CANCELLED_SYSTEM

CLAIM_REFUND

REFUND

DISPUTE

CLOSED

OFFLINE

REMIND_USER_TO_PROCEED

CAPTURED_AUTO

CAPTURED_MANUAL

ON_HOLD

READY

BACK_ORDER

Method Detail

values

valueOf