Order (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.ecom.orders.domain.BaseOrderItem
    - - com.neurosys.ecom.orders.domain.Order<I>

Type Parameters:

I - as OrderItem type

All Implemented Interfaces:

Auditable, Identifiable<Long>, FlowState, Serializable

Direct Known Subclasses:

ConvertedCurrencyOrder, ExceptionalOrderConversation, RelatedOrder
```
@Entity
public class Order<I extends OrderItem>
extends BaseOrderItem
implements FlowState, Identifiable<Long>
```
Maintains details about an Order.
Once can generate an Invoice also using an Order.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Date`	`created` Date of creation. Useful if `purchaseDate` is not same as `created` date TODO: Made nullable for now to support projects where col did not exist.
`protected Long`	`id`
`protected PaymentMethod`	`paymentMethod`
`protected Date`	`purchaseDate` Date when the order was purchased.
`protected Boolean`	`realized` If the order was realized or not.
`protected Date`	`statusDate` Date when `BaseOrderItem.status` was changed
`protected String`	`type` A type to specify the type of order.
`protected GenericEcomUser`	`user` Orders may contain `userContactDetails` and hence for `GuestUser`s in particular, user maybe optional

Fields inherited from class com.neurosys.ecom.orders.domain.BaseOrderItem
amount, finalWeight, lastStatusReason, packagingAmount, paymentContext, promotionNames, quantity, shippingAmount, status, updated

Constructor Summary

Constructors
Constructor and Description
`Order()`
`Order(GenericEcomUser user, PaymentContext paymentContext, PaymentMethod paymentMethod, Amount amount, Date purchaseDate)`
`Order(GenericEcomUser user, PaymentMethod paymentMethod)`
`Order(GenericEcomUser user, PaymentMethod paymentMethod, Amount amount)`
`Order(GenericEcomUser user, PaymentMethod paymentMethod, Amount amount, Date purchaseDate)`
`Order(Order order)`
`Order(String json)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addItem(I item)` Add `OrderItem` and do some basic checks and assignment
`void`	`addTransaction(Transaction transaction)` Add `Transaction` and do some basic checks and assignment TODO: Add Unit test case to avoid duplicates
`boolean`	`equals(Object obj)`
`String`	`getActors()` Who all were involved in the Order workflow if it involved multiple people.
`Integer`	`getBitmask()` Optional param that allows an Application to define project specific switches (boolean flags) for an Order.
`Date`	`getCreated()` Date of creation. Useful if `purchaseDate` is not same as `created` date
`DeliveryDetails`	`getDeliveryDetails()`
`FlowStatus`	`getFlowStatus()` Existing `FlowStatus`
`Long`	`getId()`
`String`	`getInvoiceId()` The Invoice ID/Number generated Clients maybe picky about Invoice Number formats etc, hence a special field provided so it does not HAVE TO be same as Order or Transaction Number.
`List<I>`	`getItems()`
`Date`	`getLastInvoiceDate()` Date the last invoice was sent for this Order An order amount can be changed and hence Invoices can be re-sent or for other reason Invoices can be sent multiple times.
`String`	`getParams()` A comma or JSON defined parameter String that allows an Application to define project specific params for an Order.
`PaymentMethod`	`getPaymentMethod()`
`Date`	`getPurchaseDate()` Date when the order was purchased.
`Boolean`	`getRealized()` If the order was realized or not.
`Date`	`getStatusDate()` Date when the `FlowStatus` was changed
`String`	`getSteps()` In a multi-step Work Flow, the steps are captured that were performed.
`String`	`getStrategiesVersion()` Track the `Strategy.getVersion()` of all strategies involved that provide their version id.
`Transaction`	`getTransaction()` Last associated successful online `Transaction` that occoured to fulfill this order
`String`	`getTransactionIds()` An order may have multiple `Transaction`s ; incase there are issues and failures to purchasing the same order a few times.
`String`	`getType()` A type to specify the type of order.
`IGenericEcomUser`	`getUser()` Orders may contain `userContactDetails` and hence for `GuestUser`s in particular, user maybe optional
`String`	`getUserContactDetails()` In addition to the default User Address and contact details; an order may define/override default `Address` with its own.
`int`	`hashCode()`
`void`	`setActors(String actors)` Who all were involved in the Order workflow if it involved multiple people.
`void`	`setBitmask(Integer bitmask)` Optional param that allows an Application to define project specific switches (boolean flags) for an Order.
`void`	`setCreated(Date created)` Date of creation. Useful if `purchaseDate` is not same as `created` date
`void`	`setDeliveryDetails(DeliveryDetails deliveryDetails)`
`void`	`setId(Long id)`
`void`	`setInvoiceId(String invoiceId)` The Invoice ID/Number generated Clients maybe picky about Invoice Number formats etc, hence a special field provided so it does not HAVE TO be same as Order or Transaction Number.
`void`	`setItems(List<I> items)`
`void`	`setLastInvoiceDate(Date lastInvoiceDate)` Date the last invoice was sent for this Order An order amount can be changed and hence Invoices can be re-sent or for other reason Invoices can be sent multiple times.
`void`	`setParams(String params)` A comma or JSON defined parameter String that allows an Application to define project specific params for an Order.
`void`	`setPaymentMethod(PaymentMethod paymentMethod)`
`void`	`setPurchaseDate(Date purchaseDate)` Date when the order was purchased.
`void`	`setRealized(Boolean realized)` If the order was realized or not.
`void`	`setStatus(OrderStatus status)`
`void`	`setStatusDate(Date statusDate)`
`void`	`setSteps(String steps)` In a multi-step Work Flow, the steps are captured that were performed.
`void`	`setStrategiesVersion(String strategiesVersion)` Track the `Strategy.getVersion()` of all strategies involved that provide their version id.
`void`	`setTransaction(Transaction transaction)` Last associated successful online `Transaction` that occoured to fulfill this order
`void`	`setTransactionIds(String transactionIds)` An order may have multiple `Transaction`s ; incase there are issues and failures to purchasing the same order a few times.
`void`	`setType(String type)` A type to specify the type of order.
`void`	`setUser(IGenericEcomUser user)` Orders may contain `userContactDetails` and hence for `GuestUser`s in particular, user maybe optional
`void`	`setUserContactDetails(String userContactDetails)` In addition to the default User Address and contact details; an order may define/override default `Address` with its own.
`void`	`synchStatusWithItems()` Convenience method to update the status of all items to the `BaseOrderItem.status`
`String`	`toString()`

Methods inherited from class com.neurosys.ecom.orders.domain.BaseOrderItem
getAmount, getComments, getFinalWeight, getLastStatusReason, getPackagingAmount, getPaymentContext, getPromotionNames, getQuantity, getShippingAmount, getStatus, getUpdated, setAmount, setComments, setFinalWeight, setLastStatusReason, setPackagingAmount, setPaymentContext, setPromotionNames, setQuantity, setShippingAmount, setUpdated

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neurosys.workflow.domain.FlowState
getUpdated

- Field Detail
  - id
```
protected Long id
```
  - paymentMethod
```
protected PaymentMethod paymentMethod
```
  - created
```
protected Date created
```
    Date of creation.
    Useful if purchaseDate is not same as created date
    TODO: Made nullable for now to support projects where col did not exist. Over time convert to non-null.
  - purchaseDate
```
protected Date purchaseDate
```
    Date when the order was purchased. For a simple work-flow this is the date when its created also.
  - user
```
protected GenericEcomUser user
```
    Orders may contain userContactDetails and hence for GuestUsers in particular, user maybe optional
    
    See Also:
    
    userContactDetails
    
    Can be null:
    
    true
  - realized
```
protected Boolean realized
```
    If the order was realized or not. REALIZED implies that on the website the user completed the flow without any problem.
    It does not for sure imply PAYMENT since payment is subject to credit, mode of payment etc. Like in a COD order there is no upfront payment.
    
    One can also rely on BaseOrderItem.getStatus() but typically like OrderStatus.CLOSED can override the state, hence we need a permanent indicator if at the time the Order was realized or not.
    
    Other indirect ways to determine if an order was realized or not is to check the Transaction.getSuccess() for ONLINE orders and for non-transactional orders check the BaseOrderItem.getLastStatusReason()
  - type
```
protected String type
```
    A type to specify the type of order. Like regular sale, Bulk etc
    Application dependent with a default of null
    
    Can be null:
    
    true
  - statusDate
```
protected Date statusDate
```
    Date when BaseOrderItem.status was changed
- Constructor Detail
  - Order
```
public Order()
```
  - Order
```
public Order(String json)
```
  - Order
```
public Order(Order order)
```
  - Order
```
public Order(GenericEcomUser user,
             PaymentMethod paymentMethod)
```
  - Order
```
public Order(GenericEcomUser user,
             PaymentMethod paymentMethod,
             Amount amount)
```
  - Order
```
public Order(GenericEcomUser user,
             PaymentMethod paymentMethod,
             Amount amount,
             Date purchaseDate)
```
  - Order
```
public Order(GenericEcomUser user,
             PaymentContext paymentContext,
             PaymentMethod paymentMethod,
             Amount amount,
             Date purchaseDate)
```
- Method Detail
  - getId
```
public Long getId()
```
    Specified by:
    
    getId in interface Identifiable<Long>
  - setId
```
public void setId(Long id)
```
    Specified by:
    
    setId in interface Identifiable<Long>
  - getPaymentMethod
```
public PaymentMethod getPaymentMethod()
```
  - setPaymentMethod
```
public void setPaymentMethod(PaymentMethod paymentMethod)
```
  - getCreated
```
public Date getCreated()
```
    Date of creation.
    Useful if purchaseDate is not same as created date
    
    Specified by:
    
    getCreated in interface FlowState
  - setCreated
```
public void setCreated(Date created)
```
    Date of creation.
    Useful if purchaseDate is not same as created date
  - getPurchaseDate
```
public Date getPurchaseDate()
```
    Date when the order was purchased. For a simple work-flow this is the date when its created also.
  - setPurchaseDate
```
public void setPurchaseDate(Date purchaseDate)
```
    Date when the order was purchased. For a simple work-flow this is the date when its created also.
  - getLastInvoiceDate
```
public Date getLastInvoiceDate()
```
    Date the last invoice was sent for this Order
    An order amount can be changed and hence Invoices can be re-sent or for other reason Invoices can be sent multiple times. For accounting purposes in Admin we should reflect the amount of the last sent and not the one, about to be sent
  - setLastInvoiceDate
```
public void setLastInvoiceDate(Date lastInvoiceDate)
```
    Date the last invoice was sent for this Order
    An order amount can be changed and hence Invoices can be re-sent or for other reason Invoices can be sent multiple times. For accounting purposes in Admin we should reflect the amount of the last sent and not the one, about to be sent
  - getUser
```
public IGenericEcomUser getUser()
```
    Orders may contain userContactDetails and hence for GuestUsers in particular, user maybe optional
    
    See Also:
    
    userContactDetails
    
    Can be null:
    
    true
  - setUser
```
public void setUser(IGenericEcomUser user)
```
    Orders may contain userContactDetails and hence for GuestUsers in particular, user maybe optional
    
    Parameters:
    
    user - as IGenericEcomUser; fo this class it is assumed to be GenericEcomUser
    
    See Also:
    
    userContactDetails
    
    Can be null:
    
    true
  - getItems
```
public List<I> getItems()
```
  - setItems
```
public void setItems(List<I> items)
```
  - getUserContactDetails
```
public String getUserContactDetails()
```
    In addition to the default User Address and contact details; an order may define/override default Address with its own. This also ensures if the user modifies their address or details; for audit purposes we know what the address was @ the point of placing the order.
    Stored as User Contact + Address's as JSON(preferable) String for the order
    
    Note: getUser() also has IGenericEcomUser.getAddresses(); this overrides that, for standard applications. While this can be an application preference; all the Utilities (like Utils.getAddresses(Order) and Utils.getAddress(Order, String) prefer to fetch from userContactDetails.
    
    See Also:
    
    Utils.getAddress(Order, String), Utils.getAddresses(Order)
  - setUserContactDetails
```
public void setUserContactDetails(String userContactDetails)
```
    In addition to the default User Address and contact details; an order may define/override default Address with its own. This also ensures if the user modifies their address or details; for audit purposes we know what the address was @ the point of placing the order.
    Stored as User Contact + Address's as JSON(preferable) String for the order
    
    Note: getUser() also has IGenericEcomUser.getAddresses(); this overrides that, for standard applications. While this can be an application preference; all the Utilities (like Utils.getAddresses(Order) and Utils.getAddress(Order, String) prefer to fetch from userContactDetails.
    
    See Also:
    
    Utils.getAddress(Order, String), Utils.getAddresses(Order)
  - getInvoiceId
```
public String getInvoiceId()
```
    The Invoice ID/Number generated
    Clients maybe picky about Invoice Number formats etc, hence a special field provided so it does not HAVE TO be same as Order or Transaction Number.
    A invoiceId does not have to be unique either; since in complex situation adjustments can be made on the Same Invoice so provides a way to tie multiple transactions cross orders on the same Invoice; if required (ideally not the case but should give provision for such situations)
  - setInvoiceId
```
public void setInvoiceId(String invoiceId)
```
    The Invoice ID/Number generated
    Clients maybe picky about Invoice Number formats etc, hence a special field provided so it does not HAVE TO be same as Order or Transaction Number.
    A invoiceId does not have to be unique either; since in complex situation adjustments can be made on the Same Invoice so provides a way to tie multiple transactions cross orders on the same Invoice; if required (ideally not the case but should give provision for such situations)
  - getType
```
public String getType()
```
    A type to specify the type of order. Like regular sale, Bulk etc
    Application dependent with a default of null
    
    Can be null:
    
    true
  - setType
```
public void setType(String type)
```
    A type to specify the type of order. Like regular sale, Bulk etc
    Application dependent with a default of null
    
    Can be null:
    
    true
  - getTransaction
```
public Transaction getTransaction()
```
    Last associated successful online Transaction that occoured to fulfill this order
  - setTransaction
```
public void setTransaction(Transaction transaction)
```
    Last associated successful online Transaction that occoured to fulfill this order
  - getTransactionIds
```
public String getTransactionIds()
```
    An order may have multiple Transactions ; incase there are issues and failures to purchasing the same order a few times. All transaction Ids are captured as a comma separated String for reference purposes
  - setTransactionIds
```
public void setTransactionIds(String transactionIds)
```
    An order may have multiple Transactions ; incase there are issues and failures to purchasing the same order a few times. All transaction Ids are captured as a comma separated String for reference purposes
  - getDeliveryDetails
```
public DeliveryDetails getDeliveryDetails()
```
  - setDeliveryDetails
```
public void setDeliveryDetails(DeliveryDetails deliveryDetails)
```
  - addItem
```
public void addItem(I item)
```
    Add OrderItem and do some basic checks and assignment
  - addTransaction
```
public void addTransaction(Transaction transaction)
```
    Add Transaction and do some basic checks and assignment
    TODO: Add Unit test case to avoid duplicates
  - synchStatusWithItems
```
public void synchStatusWithItems()
```
    Convenience method to update the status of all items to the BaseOrderItem.status
  - getSteps
```
public String getSteps()
```
    In a multi-step Work Flow, the steps are captured that were performed.
    Typical use would be with PaymentMethod.WORK_FLOW, OrderStatus.CAPTURED_AUTO + OrderStatus.PLACED_MANUAL etc
  - setSteps
```
public void setSteps(String steps)
```
    In a multi-step Work Flow, the steps are captured that were performed.
    Typical use would be with PaymentMethod.WORK_FLOW, OrderStatus.CAPTURED_AUTO + OrderStatus.PLACED_MANUAL etc
  - getStrategiesVersion
```
public String getStrategiesVersion()
```
    Track the Strategy.getVersion() of all strategies involved that provide their version id.
  - setStrategiesVersion
```
public void setStrategiesVersion(String strategiesVersion)
```
    Track the Strategy.getVersion() of all strategies involved that provide their version id.
  - getBitmask
```
public Integer getBitmask()
```
    Optional param that allows an Application to define project specific switches (boolean flags) for an Order. The interpretation is application specific and the field just provides a compact way to represent multiple boolean flags.
    
    Can be null:
    
    true
  - setBitmask
```
public void setBitmask(Integer bitmask)
```
    Optional param that allows an Application to define project specific switches (boolean flags) for an Order. The interpretation is application specific and the field just provides a compact way to represent multiple boolean flags.
    
    Can be null:
    
    true
  - getActors
```
public String getActors()
```
    Who all were involved in the Order workflow if it involved multiple people. A Comma separated sequence of Name Ids. If NULL it implies the USER, else a name(s) or System recognizable Id(s) will be specified.
    
    Can be null:
    
    true
  - setActors
```
public void setActors(String actors)
```
    Who all were involved in the Order workflow if it involved multiple people. A Comma separated sequence of Name Ids. If NULL it implies the USER, else a name(s) or System recognizable Id(s) will be specified.
    
    Can be null:
    
    true
  - getParams
```
public String getParams()
```
    A comma or JSON defined parameter String that allows an Application to define project specific params for an Order. The interpretation is application specific for any type of additional data we want to associate with the Order.
  - setParams
```
public void setParams(String params)
```
    A comma or JSON defined parameter String that allows an Application to define project specific params for an Order. The interpretation is application specific for any type of additional data we want to associate with the Order.
  - getRealized
```
public Boolean getRealized()
```
    If the order was realized or not. REALIZED implies that on the website the user completed the flow without any problem.
    It does not for sure imply PAYMENT since payment is subject to credit, mode of payment etc. Like in a COD order there is no upfront payment.
    
    One can also rely on BaseOrderItem.getStatus() but typically like OrderStatus.CLOSED can override the state, hence we need a permanent indicator if at the time the Order was realized or not.
    
    Other indirect ways to determine if an order was realized or not is to check the Transaction.getSuccess() for ONLINE orders and for non-transactional orders check the BaseOrderItem.getLastStatusReason()
  - setRealized
```
public void setRealized(Boolean realized)
```
    If the order was realized or not. REALIZED implies that on the website the user completed the flow without any problem.
    It does not for sure imply PAYMENT since payment is subject to credit, mode of payment etc. Like in a COD order there is no upfront payment.
    
    One can also rely on BaseOrderItem.getStatus() but typically like OrderStatus.CLOSED can override the state, hence we need a permanent indicator if at the time the Order was realized or not.
    
    Other indirect ways to determine if an order was realized or not is to check the Transaction.getSuccess() for ONLINE orders and for non-transactional orders check the BaseOrderItem.getLastStatusReason()
  - getFlowStatus
```
public FlowStatus getFlowStatus()
```
    Description copied from interface: FlowState
    
    Existing FlowStatus
    
    Specified by:
    
    getFlowStatus in interface FlowState
  - getStatusDate
```
public Date getStatusDate()
```
    Description copied from interface: FlowState
    
    Date when the FlowStatus was changed
    
    Specified by:
    
    getStatusDate in interface FlowState
  - setStatusDate
```
public void setStatusDate(Date statusDate)
```
  - setStatus
```
public void setStatus(OrderStatus status)
```
    Overrides:
    
    setStatus in class BaseOrderItem
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class BaseOrderItem
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class BaseOrderItem
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BaseOrderItem

Class Order<I extends OrderItem>

Field Summary

Fields inherited from class com.neurosys.ecom.orders.domain.BaseOrderItem

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.ecom.orders.domain.BaseOrderItem

Methods inherited from class java.lang.Object

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

Field Detail

id

paymentMethod

created

purchaseDate

user

realized

type

statusDate

Constructor Detail

Order

Order

Order

Order

Order

Order

Order

Method Detail

getId

setId

getPaymentMethod

setPaymentMethod

getCreated

setCreated

getPurchaseDate

setPurchaseDate

getLastInvoiceDate

setLastInvoiceDate

getUser

setUser

getItems

setItems

getUserContactDetails

setUserContactDetails

getInvoiceId

setInvoiceId

getType

setType

getTransaction

setTransaction

getTransactionIds

setTransactionIds

getDeliveryDetails

setDeliveryDetails

addItem

addTransaction

synchStatusWithItems

getSteps

setSteps

getStrategiesVersion

setStrategiesVersion

getBitmask

setBitmask

getActors

setActors

getParams

setParams

getRealized

setRealized

getFlowStatus

getStatusDate

setStatusDate

setStatus

equals

hashCode

toString