com.neurosys.ecom.orders.domain

Class SubOrder<O extends Order<I>,I extends OrderItem>

java.lang.Object

com.neurosys.domain.ModelObject

com.neurosys.domain.DomainObject

com.neurosys.ecom.orders.domain.BaseOrderItem

com.neurosys.ecom.orders.domain.Order<I>

com.neurosys.ecom.orders.domain.RelatedOrder<O,I>

com.neurosys.ecom.orders.domain.SubOrder<O,I>

Type Parameters:

I - as OrderItem type

O - as Order type of root

All Implemented Interfaces:

Auditable, IHierarchialReference<Long>, Identifiable<Long>, FlowState, Serializable, Iterator<O>

@Entity
public class SubOrder<O extends Order<I>,I extends OrderItem>
extends RelatedOrder<O,I>
implements Iterator<O>, IHierarchialReference<Long>

Special case of a RelatedOrder that tracks its own partialAmount and previous and next.
A SubOrder shares the same OrderItem of its RelatedOrder.getRoot() by overriding getItems(). The items of the SubOrder are by default null to avoid multiple copies, and rather rely on the getItems() method.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	hierarchy Relative to its RelatedOrder.getRoot(); the sequence IHierarchialReferencegetHierarchy()
protected Amount	partialAmount Amount the SubOrder is worth / Partial Payment Amount

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

root

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

created, id, paymentMethod, purchaseDate, realized, statusDate, type, user

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

amount, finalWeight, lastStatusReason, packagingAmount, paymentContext, promotionNames, quantity, shippingAmount, status, updated

Fields inherited from interface com.neurosys.domain.IHierarchialReference

ROOT

Constructor Summary

Constructors

Constructor and Description
SubOrder()
SubOrder(GenericEcomUser user, PaymentContext paymentContext, PaymentMethod paymentMethod, Amount amount, Date purchaseDate)
SubOrder(GenericEcomUser user, PaymentMethod paymentMethod)
SubOrder(GenericEcomUser user, PaymentMethod paymentMethod, Amount amount)
SubOrder(GenericEcomUser user, PaymentMethod paymentMethod, Amount amount, Date purchaseDate)
SubOrder(O root)
SubOrder(O root, Amount partialAmount)
SubOrder(String json)
SubOrder(SubOrder<O,I> previous)
SubOrder(SubOrder<O,I> previousOrRoot, Amount partialAmount)

Method Summary

Modifier and Type	Method and Description
String	getHierarchy() A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
List<I>	getItems()
String	getName() Return Order.getId()
<S extends SubOrder<O,I>> S	getNext() In the sequence of Orders created, the next SubOrder The first most element may or may not be the parent.
Long	getParentId()
Amount	getPartialAmount() Amount the SubOrder is worth / Partial Payment Amount
Double	getPayableTotal() Payable Total for a SubOrder = partialAmount.total (if it exists) else Payable Total for a SubOrder = amount.total - any partialAmount.discount The method is provided to define a consistent meaning of a payable total for the SubOrder.
<S extends SubOrder<O,I>> S	getPrevious() In the sequence of Orders created, the previous SubOrder The first most element may or may not be the parent.
Boolean	getSucceded() If A SubOrder is created for this one that succeeds it. This reflects both (linear or hierarchical) succession.
Double	getTotalDiscount() In the SubOrder the discount has 2 components.
boolean	hasNext()
O	next()
void	remove()
protected void	set(O root) Inherit some properties from root; if root is null then leave state unchanged
void	setHierarchy(String hierarchy) A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
void	setName(String name) Method not supported for this implementation
<S extends SubOrder<O,I>> void	setNext(S next) In the sequence of Orders created, the next SubOrder The first most element may or may not be the parent.
void	setParentId(Long parentId) Method not supported for this implementation, as we cannot override RelatedOrder.getRoot()Order.setId(Long).
void	setPartialAmount(Amount partialAmount) Amount the SubOrder is worth / Partial Payment Amount
<S extends SubOrder<O,I>> void	setPrevious(S previous) In the sequence of Orders created, the previous SubOrder The first most element may or may not be the parent.
void	setSucceded(Boolean succeded) If A SubOrder is created for this one that succeeds it. This reflects both (linear or hierarchical) succession.
String	toString()
void	validateRelations() Since a double linked list is created , also validate the list to ensure no wierd links or kinks created Detect cycles, error for current node.

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

deriveRoot, getRoot, setRoot

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

addItem, addTransaction, equals, getActors, getBitmask, getCreated, getDeliveryDetails, getFlowStatus, getId, getInvoiceId, getLastInvoiceDate, getParams, getPaymentMethod, getPurchaseDate, getRealized, getStatusDate, getSteps, getStrategiesVersion, getTransaction, getTransactionIds, getType, getUser, getUserContactDetails, hashCode, setActors, setBitmask, setCreated, setDeliveryDetails, setId, setInvoiceId, setItems, setLastInvoiceDate, setParams, setPaymentMethod, setPurchaseDate, setRealized, setStatus, setStatusDate, setSteps, setStrategiesVersion, setTransaction, setTransactionIds, setType, setUser, setUserContactDetails, synchStatusWithItems

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 java.util.Iterator

forEachRemaining

Methods inherited from interface com.neurosys.domain.IHierarchialReference

getId, setId

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

getUpdated

Field Detail

partialAmount

protected Amount partialAmount

Amount the SubOrder is worth / Partial Payment Amount

hierarchy

protected String hierarchy

Relative to its RelatedOrder.getRoot(); the sequence IHierarchialReferencegetHierarchy()

Constructor Detail

SubOrder

public SubOrder()

SubOrder

public SubOrder(String json)

SubOrder

public SubOrder(GenericEcomUser user,
                PaymentMethod paymentMethod)

SubOrder

public SubOrder(GenericEcomUser user,
                PaymentMethod paymentMethod,
                Amount amount)

SubOrder

public SubOrder(GenericEcomUser user,
                PaymentMethod paymentMethod,
                Amount amount,
                Date purchaseDate)

SubOrder

public SubOrder(GenericEcomUser user,
                PaymentContext paymentContext,
                PaymentMethod paymentMethod,
                Amount amount,
                Date purchaseDate)

SubOrder

public SubOrder(O root,
                Amount partialAmount)

Parameters:

root - as Order

partialAmount -

SubOrder

public SubOrder(SubOrder<O,I> previousOrRoot,
                Amount partialAmount)

SubOrder

public SubOrder(O root)

SubOrder

public SubOrder(SubOrder<O,I> previous)

Method Detail

set

protected void set(O root)

Inherit some properties from root; if root is null then leave state unchanged

Overrides:

set in class RelatedOrder<O extends Order<I>,I extends OrderItem>

Parameters:

root - as

getPrevious

public <S extends SubOrder<O,I>> S getPrevious()

In the sequence of Orders created, the previous SubOrder
The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.

Can be null:

true

setPrevious

public <S extends SubOrder<O,I>> void setPrevious(S previous)

In the sequence of Orders created, the previous SubOrder
The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.

Can be null:

true

getNext

public <S extends SubOrder<O,I>> S getNext()

In the sequence of Orders created, the next SubOrder
The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.

Can be null:

true

setNext

public <S extends SubOrder<O,I>> void setNext(S next)

In the sequence of Orders created, the next SubOrder
The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.

Can be null:

true

getPartialAmount

public Amount getPartialAmount()

Amount the SubOrder is worth / Partial Payment Amount

setPartialAmount

public void setPartialAmount(Amount partialAmount)

Amount the SubOrder is worth / Partial Payment Amount

getTotalDiscount

public Double getTotalDiscount()

In the SubOrder the discount has 2 components. The discount component from the amount and the partialAmount
The method is provided to define a consistent meaning of a discount for the SubOrder. One can override this method to change what a total discount means, when looking @ a particular SubOrder

Returns:

Double

Can be null:

true

getPayableTotal

public Double getPayableTotal()

Payable Total for a SubOrder = partialAmount.total (if it exists) else Payable Total for a SubOrder = amount.total - any partialAmount.discount
The method is provided to define a consistent meaning of a payable total for the SubOrder. One can override this method to change what a total means, when looking @ a particular SubOrder

Returns:

the calculated actual payable amount for this order

Can be null:

true

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<O extends Order<I>>

next

public O next()

Specified by:

next in interface Iterator<O extends Order<I>>

getSucceded

public Boolean getSucceded()

If A SubOrder is created for this one that succeeds it.
This reflects both (linear or hierarchical) succession.

Overrides:

getSucceded in class RelatedOrder<O extends Order<I>,I extends OrderItem>

setSucceded

public void setSucceded(Boolean succeded)

If A SubOrder is created for this one that succeeds it.
This reflects both (linear or hierarchical) succession.

Overrides:

setSucceded in class RelatedOrder<O extends Order<I>,I extends OrderItem>

remove

public void remove()

Specified by:

remove in interface Iterator<O extends Order<I>>

validateRelations

public void validateRelations()
                       throws javax.validation.ValidationException

Since a double linked list is created , also validate the list to ensure no wierd links or kinks created Detect cycles, error for current node.

Throws:

javax.validation.ValidationException

getItems

public List<I> getItems()

Overrides:

getItems in class Order<I extends OrderItem>

toString

public String toString()

Overrides:

toString in class RelatedOrder<O extends Order<I>,I extends OrderItem>

getName

public String getName()

Return Order.getId()

Specified by:

getName in interface IHierarchialReference<Long>

setName

public void setName(String name)

Method not supported for this implementation

Specified by:

setName in interface IHierarchialReference<Long>

getParentId

public Long getParentId()

Specified by:

getParentId in interface IHierarchialReference<Long>

setParentId

public void setParentId(Long parentId)

Method not supported for this implementation, as we cannot override RelatedOrder.getRoot()Order.setId(Long). No benefit.

Specified by:

setParentId in interface IHierarchialReference<Long>

getHierarchy

public String getHierarchy()

Description copied from interface: IHierarchialReference

A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.

Specified by:

getHierarchy in interface IHierarchialReference<Long>

setHierarchy

public void setHierarchy(String hierarchy)

Description copied from interface: IHierarchialReference

A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.

Specified by:

setHierarchy in interface IHierarchialReference<Long>