com.neurosys.ecom.strategy.service

Class DefaultSubOrderStrategy<P extends Product,U extends IGenericEcomUser,O extends SubOrder<O,I>,I extends OrderItem>

java.lang.Object

com.neurosys.ecom.strategy.service.AbstractStrategy<P,U>

com.neurosys.ecom.strategy.service.AbstractChargeStrategy<P,U>

com.neurosys.ecom.strategy.service.DefaultOrderStrategy<P,U,O,I>

com.neurosys.ecom.strategy.service.DefaultSubOrderStrategy<P,U,O,I>

Type Parameters:

P - as Product

U - as User

O - as SubOrder

I - as OrderItem

All Implemented Interfaces:

ChargeStrategy<P,U>, CumulativeChargeStrategy<P,U>, OrderStrategy<P,U,O,I>, Strategy

public class DefaultSubOrderStrategy<P extends Product,U extends IGenericEcomUser,O extends SubOrder<O,I>,I extends OrderItem>
extends DefaultOrderStrategy<P,U,O,I>

Extension to DefaultOrderStrategy to support additional SubOrder specific common cases.

Author:

Arjun Dhar

Field Summary

Fields inherited from class com.neurosys.ecom.strategy.service.DefaultOrderStrategy

blockOrders, contextProviderStrategy, discountStrategy, orderService, packagingStrategy, promotionStrategy, saleStrategy, shippingStrategy

Fields inherited from class com.neurosys.ecom.strategy.service.AbstractChargeStrategy

taxStrategy

Fields inherited from class com.neurosys.ecom.strategy.service.AbstractStrategy

productService, scanHierarchy

Constructor Summary

Constructors

Constructor and Description
DefaultSubOrderStrategy()

Method Summary

Modifier and Type	Method and Description
void	autoCalcPartialAmountForNextSubOrder(O nextNew) If SubOrder.getPartialAmount() is null for the new Sub Order, then ensure sequence is valid using #sequenceSubOrderTransformer and then initialize it by auto Calculate the SubOrder.setPartialAmount(Amount) for the next SubOrder and set it in the same object.
double	calculateCumulativeDiscount(O order) Formule: Cum.
Amount	calculateCumulativePartialAmountsSoFar(O order, boolean considerOnlyRealizedOrders, boolean validateRelations) Sum all SubOrder.getPartialAmount().
double	calculateCurrentTotal(O order) Calculate current net value of the Order. The word "current" is used, to imply that depending on the application, future SubOrders with discounts maybe created, in that case this value will change.
double	calculatePayableTotal(O order)
double	calculateRemainder(O order) For a SubOrder calculate remainder amount based on SubOrder Amount.getTotal() - calculateCumulativePartialAmountsSoFar(SubOrder, boolean, boolean). The calculateCumulativePartialAmountsSoFar method is given (order, true, false) as params.
O	createAndInitSubOrder(O rootOrPrev) Convenience method that creates and Initializes an instance of SubOrder, with calculations like remainder payable, sequencing SubOrder for a given root if not already sequenced. Persists the created order also.
O	initSubOrder(O newSubOrderBasedonRoot, O rootOrPrev) Convenience method that Initializes an instance with calculations like remainder payable, sequencing SubOrder for a given root if not already sequenced. Persists the created order also.

Methods inherited from class com.neurosys.ecom.strategy.service.DefaultOrderStrategy

calculate, createOrder, createOrder, createOrderItem, getContextProviderStrategy, getDiscountStrategy, getOrderInstance, getOrderService, getPackagingStrategy, getPromotionStrategy, getSaleStrategy, getShippingStrategy, getStrategiesVerson, isBlockOrders, onOrderComplete, processOrderItem, setBlockOrders, setContextProviderStrategy, setDiscountStrategy, setOrderService, setPackagingStrategy, setPromotionStrategy, setSaleStrategy, setShippingStrategy, validateOrder

Methods inherited from class com.neurosys.ecom.strategy.service.AbstractChargeStrategy

applyTax, calculate, getTaxStrategy, getVersion, setTaxStrategy

Methods inherited from class com.neurosys.ecom.strategy.service.AbstractStrategy

getProductService, getRepresentativeProduct, isScanHierarchy, setProductService, setScanHierarchy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.neurosys.ecom.strategy.service.Strategy

getVersion

Constructor Detail

DefaultSubOrderStrategy

public DefaultSubOrderStrategy()

Method Detail

initSubOrder

@Transactional(readOnly=false)
public O initSubOrder(O newSubOrderBasedonRoot,
                                                     O rootOrPrev)

Convenience method that Initializes an instance with calculations like remainder payable, sequencing SubOrder for a given root if not already sequenced.
Persists the created order also.

Parameters:

newSubOrderBasedonRoot - as O SubOrder type. This is typically created using a Constructor method of SubOrder using root as a param.

rootOrPrev - as O SubOrder type as Root or Previous SubOrder type

Returns:

SubOrder as O SubOrder type, as updated and persisted version of newSubOrderBasedonRoot

createAndInitSubOrder

@Transactional(readOnly=false)
public O createAndInitSubOrder(O rootOrPrev)

Convenience method that creates and Initializes an instance of SubOrder, with calculations like remainder payable, sequencing SubOrder for a given root if not already sequenced.
Persists the created order also.

Parameters:

rootOrPrev - as O SubOrder type

Returns:

SubOrder as O SubOrder type

calculatePayableTotal

public double calculatePayableTotal(O order)

Returns:

double

See Also:

SubOrder.getPayableTotal()

calculateCumulativePartialAmountsSoFar

public Amount calculateCumulativePartialAmountsSoFar(O order,
                                                     boolean considerOnlyRealizedOrders,
                                                     boolean validateRelations)

Sum all SubOrder.getPartialAmount(). RelatedOrder.getRoot() is only considered if it is also a SubOrder type.
If partial Amount not available for a SubOrder then it will assume full amount for that SubOrder
Assumes all #getPrevious() are available for the order hat is input to this function.
This default impl does not perform any additional query.

Parameters:

order - as SubOrder type

considerOnlyRealizedOrders - as boolean. If true will consider only orders that are realized

validateRelations - as boolean. If true will execute SubOrder.validateRelations() on each relation it iterates over

Returns:

double

calculateCumulativeDiscount

public double calculateCumulativeDiscount(O order)

Formule: Cum. Discount = BaseOrderItem.getAmount().discount + All cumulative discounts for ALL related SubOrder.getPartialAmount()s
This default impl does not perform any additional query.

Returns:

double

See Also:

calculateCumulativePartialAmountsSoFar(SubOrder, boolean, boolean)

calculateRemainder

public double calculateRemainder(O order)

For a SubOrder calculate remainder amount based on SubOrder Amount.getTotal() - calculateCumulativePartialAmountsSoFar(SubOrder, boolean, boolean).
The calculateCumulativePartialAmountsSoFar method is given (order, true, false) as params. Also the discount assumes that no matter what the amounts paid, the discounts cumulate from the total and hence are considered in cumulation.
Only Order.getRealized()=true are considered for payments made so far.

Formule: Remainder = Total as (order.getAmount().getTotal()) - (All cumulative amounts from ONLY realized related SubOrder.getPartialAmount()s) - (All cumulative discounts for ALL related SubOrder.getPartialAmount()s)
Note: In this implementation Total assumes order.getAmount().getDiscount() already included in it, and hence this implementation assumes discounts as any further discounts via SubOrder.getPartialAmount().
This default impl does not perform any additional query.

Parameters:

order - as SubOrder type

Returns:

double

See Also:

calculateCumulativePartialAmountsSoFar(SubOrder, boolean, boolean)

calculateCurrentTotal

public double calculateCurrentTotal(O order)

Calculate current net value of the Order.
The word "current" is used, to imply that depending on the application, future SubOrders with discounts maybe created, in that case this value will change.

Formule: Current Net = Total - (All cumulative discounts for ALL related SubOrder.getPartialAmount()s)
Note: In this implementation Total assumes order.getAmount().getDiscount() already included in it, and hence this implementation assumes discounts as any further discounts via SubOrder.getPartialAmount().
This default impl does not perform any additional query.

Parameters:

order - as SubOrder type

Returns:

double

See Also:

Order.amount.total, calculateCumulativePartialAmountsSoFar.discount For realized orders

autoCalcPartialAmountForNextSubOrder

public void autoCalcPartialAmountForNextSubOrder(O nextNew)

If SubOrder.getPartialAmount() is null for the new Sub Order, then ensure sequence is valid using #sequenceSubOrderTransformer and then initialize it by auto Calculate the SubOrder.setPartialAmount(Amount) for the next SubOrder and set it in the same object.
Only Order.getRealized()=true are considered for payments made so far.

Parameters:

nextNew - as O of type SubOrder