com.neurosys.ecom.strategy.service

Class DefaultOrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<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>

Type Parameters:

P - as Product

U - as User

O - as Order

I - as OrderItem

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultSubOrderStrategy

public class DefaultOrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<I>,I extends OrderItem>
extends AbstractChargeStrategy<P,U>
implements OrderStrategy<P,U,O,I>

Allow amalgamation of other strategies to a List of Products that constitute an Order and produce a Persistent Order

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	blockOrders A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
protected ContextProviderStrategy	contextProviderStrategy
protected CumulativeChargeStrategy<P,U>	discountStrategy
protected OrderService<O,I>	orderService
protected CumulativeChargeStrategy<P,U>	packagingStrategy
protected PromotionStrategy<P,U>	promotionStrategy
protected SaleStrategy<P,U>	saleStrategy
protected CumulativeChargeStrategy<P,U>	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
DefaultOrderStrategy()

Method Summary

Modifier and Type	Method and Description
<CONTEXT> Amount	calculate(P product, Number quantity, U user, String currency, List<PromotionForUser> promotions, CONTEXT context) Will add amount from ChargeStrategy.calculate(Product, Number, User, String, List, Object) for each of the following strategies in order @ The product level. The rules of Amount.add(Amount) will apply while adding: saleStrategy discountStrategy promotionStrategy
<CONTEXT> O	createOrder(Map<P,Number> productQtyMap, U user, String currency, List<PromotionForUser> promotions, Map<String,Object> itemProperties, boolean persist, CONTEXT context)
<CONTEXT> O	createOrder(Map<P,Number> productQtyMap, U user, String currency, List<PromotionForUser> promotions, Map<String,Object> itemProperties, boolean persist, org.apache.commons.collections.Transformer transformer, CONTEXT context) Create an Order Note: A helper method that directly accepts Cart could be convenient, however most order creation data are also contextual and it would additionally require other services to be part ofthe OrderStrategy which would not make it clean.
protected I	createOrderItem(O order, P p, Amount totalAmtForProduct, Number quantity, Map<String,Object> itemProperties) Override for custom OrderItem type
ContextProviderStrategy	getContextProviderStrategy()
CumulativeChargeStrategy<P,U>	getDiscountStrategy()
protected O	getOrderInstance() Override for custom Order type
OrderService<O,I>	getOrderService() Access to the underlying OrderService
CumulativeChargeStrategy<P,U>	getPackagingStrategy()
PromotionStrategy<P,U>	getPromotionStrategy()
SaleStrategy<P,U>	getSaleStrategy()
CumulativeChargeStrategy<P,U>	getShippingStrategy()
protected String	getStrategiesVerson() JSON Map String of all Strategies version used for the order.
boolean	isBlockOrders() A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
void	onOrderComplete(O order, String sessionId) When an Order is successfully Completed; then some actions should be taken.
protected void	processOrderItem(I item, Map<String,Object> itemProperties) Customize OrderItem data based on properties
void	setBlockOrders(boolean blockOrders) A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
void	setContextProviderStrategy(ContextProviderStrategy contextProviderStrategy)
void	setDiscountStrategy(CumulativeChargeStrategy<P,U> discountStrategy)
void	setOrderService(OrderService<O,I> orderService)
void	setPackagingStrategy(CumulativeChargeStrategy<P,U> packagingStrategy)
void	setPromotionStrategy(PromotionStrategy<P,U> promotionStrategy)
void	setSaleStrategy(SaleStrategy<P,U> saleStrategy)
void	setShippingStrategy(CumulativeChargeStrategy<P,U> shippingStrategy)
protected void	validateOrder(O order) Any validation criteria to allow the order to pass or not.

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

Field Detail

orderService

protected OrderService<O extends Order<I>,I extends OrderItem> orderService

shippingStrategy

protected CumulativeChargeStrategy<P extends Product,U extends IGenericEcomUser> shippingStrategy

packagingStrategy

protected CumulativeChargeStrategy<P extends Product,U extends IGenericEcomUser> packagingStrategy

discountStrategy

protected CumulativeChargeStrategy<P extends Product,U extends IGenericEcomUser> discountStrategy

saleStrategy

protected SaleStrategy<P extends Product,U extends IGenericEcomUser> saleStrategy

promotionStrategy

protected PromotionStrategy<P extends Product,U extends IGenericEcomUser> promotionStrategy

contextProviderStrategy

protected ContextProviderStrategy contextProviderStrategy

blockOrders

protected boolean blockOrders

A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
One may override validateOrder(Order) to implement more complex scenarios.
Be sure to call super.allowOrder(O) to ensure base class expectations are also met.

Default value:

false

Constructor Detail

DefaultOrderStrategy

public DefaultOrderStrategy()

Method Detail

calculate

public <CONTEXT> Amount calculate(P product,
                                  Number quantity,
                                  U user,
                                  String currency,
                                  List<PromotionForUser> promotions,
                                  CONTEXT context)

Will add amount from ChargeStrategy.calculate(Product, Number, User, String, List, Object) for each of the following strategies in order @ The product level.
The rules of Amount.add(Amount) will apply while adding:

1. saleStrategy
2. discountStrategy
3. promotionStrategy

Specified by:

calculate in interface ChargeStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

product - as P

quantity - as Number

user - as U @NUllable true

currency - as String @nullable true. A null implies default currency

Returns:

Amount @nullable true (implementation dependent)

validateOrder

protected void validateOrder(O order)
                      throws OrderPlacementException

Any validation criteria to allow the order to pass or not. This is called before the Order is persisted!

Parameters:

order - as O

Throws:

OrderPlacementException

processOrderItem

protected void processOrderItem(I item,
                                Map<String,Object> itemProperties)

Customize OrderItem data based on properties

Parameters:

item - as OrderItem

itemProperties - @nullable true, as Map of additional properties for each product related (OrderItem). Key in map is same as product identifier (Product.getName() by default convention)

createOrderItem

protected I createOrderItem(O order,
                            P p,
                            Amount totalAmtForProduct,
                            Number quantity,
                            Map<String,Object> itemProperties)

Override for custom OrderItem type

Returns:

OrderItem type object

getOrderInstance

protected O getOrderInstance()

Override for custom Order type

Returns:

Order type object

createOrder

@Transactional(readOnly=false)
public <CONTEXT> O createOrder(Map<P,Number> productQtyMap,
                                                              U user,
                                                              String currency,
                                                              List<PromotionForUser> promotions,
                                                              Map<String,Object> itemProperties,
                                                              boolean persist,
                                                              org.apache.commons.collections.Transformer transformer,
                                                              CONTEXT context)
                                                       throws OrderPlacementException

Create an Order

Note: A helper method that directly accepts Cart could be convenient, however most order creation data are also contextual and it would additionally require other services to be part ofthe OrderStrategy which would not make it clean. For these reasons there is no direct method to accept Cart. One can use the following code to support the transition, for example:

                                Map productQuantityMap = cartService.convertToProductQuantityMap(cart); 
                                order = orderStrategy.createOrder(productQuantityMap, user, null Default Currency, null  No promotions, false    , orderProcessHelper.deriveContext(user, getRequestCycle()));
 

or one can use OrderProcessHelper#deriveOrder(Map, IGenericEcomUser, String, Class, Order, String, org.apache.wicket.RequestCycle, org.apache.wicket.Response)

Specified by:

createOrder in interface OrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<I>,I extends OrderItem>

Parameters:

productQtyMap - as Map of Product to Number (Quantity)

user - as User @nullable true (In case of GuestUser, optional)

currency - as String @nullable true. A null implies default currency

promotions - as List of Promotions

itemProperties - as Map of additional properties for each product (OrderItem)

persist - as boolean; if true will persist the Order instance and return an Order with Order.getId() that is also persisted

transformer - as Transformer (Optional), to perform any additional transformation over the in process Order Object before its persisted @nullable true

context - as varargs

Returns:

Order

Throws:

OrderPlacementException

createOrder

@Transactional(readOnly=false)
public <CONTEXT> O createOrder(Map<P,Number> productQtyMap,
                                                              U user,
                                                              String currency,
                                                              List<PromotionForUser> promotions,
                                                              Map<String,Object> itemProperties,
                                                              boolean persist,
                                                              CONTEXT context)
                                                       throws OrderPlacementException

Specified by:

createOrder in interface OrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<I>,I extends OrderItem>

Throws:

OrderPlacementException

See Also:

#createOrder(Map, IGenericEcomUser, String, List, Map, boolean, Transformer, Object...)

onOrderComplete

@Transactional(readOnly=false,
               noRollbackFor=java.lang.Exception.class)
public void onOrderComplete(O order,
                                                                                                                   String sessionId)

When an Order is successfully Completed; then some actions should be taken. Like (Note these are examples and implementation dependent):

• Notifications & Invoices - Note; one may choose to send those via a ChangeListener hooked into OrderService or TransactionService also
• Reduce Stock Count of products
• UnLock existing locks for Products that were in Order that completed
• Commit any coupons / PromotionForUsers

• Reduce Stock Count of products in Order
• Un-Lock products in Order

Specified by:

onOrderComplete in interface OrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<I>,I extends OrderItem>

Parameters:

order - as O

See Also:

ChangeGenerator, {@link ChangeListener}, {@link PostOrderProcessStrategy} as possible implementation aids.

getStrategiesVerson

protected String getStrategiesVerson()

JSON Map String of all Strategies version used for the order. The map definition is {Key = Strategy/Class Name, Value = version}

Returns:

String @nullable true

See Also:

Order.getStrategiesVersion()

isBlockOrders

public boolean isBlockOrders()

A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
One may override validateOrder(Order) to implement more complex scenarios.
Be sure to call super.allowOrder(O) to ensure base class expectations are also met.

Default value:

false

setBlockOrders

public void setBlockOrders(boolean blockOrders)

A quick set flag if we wish to block taking orders due to any reason like maintenance etc.
One may override validateOrder(Order) to implement more complex scenarios.
Be sure to call super.allowOrder(O) to ensure base class expectations are also met.

Default value:

false

getOrderService

public OrderService<O,I> getOrderService()

Description copied from interface: OrderStrategy

Access to the underlying OrderService

Specified by:

getOrderService in interface OrderStrategy<P extends Product,U extends IGenericEcomUser,O extends Order<I>,I extends OrderItem>

Returns:

setOrderService

public void setOrderService(OrderService<O,I> orderService)

getSaleStrategy

public SaleStrategy<P,U> getSaleStrategy()

setSaleStrategy

public void setSaleStrategy(SaleStrategy<P,U> saleStrategy)

getShippingStrategy

public CumulativeChargeStrategy<P,U> getShippingStrategy()

setShippingStrategy

public void setShippingStrategy(CumulativeChargeStrategy<P,U> shippingStrategy)

getPackagingStrategy

public CumulativeChargeStrategy<P,U> getPackagingStrategy()

setPackagingStrategy

public void setPackagingStrategy(CumulativeChargeStrategy<P,U> packagingStrategy)

getDiscountStrategy

public CumulativeChargeStrategy<P,U> getDiscountStrategy()

setDiscountStrategy

public void setDiscountStrategy(CumulativeChargeStrategy<P,U> discountStrategy)

getPromotionStrategy

public PromotionStrategy<P,U> getPromotionStrategy()

setPromotionStrategy

public void setPromotionStrategy(PromotionStrategy<P,U> promotionStrategy)

getContextProviderStrategy

public ContextProviderStrategy getContextProviderStrategy()

setContextProviderStrategy

public void setContextProviderStrategy(ContextProviderStrategy contextProviderStrategy)