com.neurosys.ecom.orders.wicket

Class OrderProcessHelper<O extends Order<?>>

java.lang.Object

com.neurosys.ecom.orders.wicket.OrderProcessHelper<O>

Type Parameters:

O - as Order

All Implemented Interfaces:

Strategy

public class OrderProcessHelper<O extends Order<?>>
extends Object
implements Strategy

Some common Oreder processing activities and methods that are provided as Helpers in the context of Wicket Components / View Layer
Also ensure to check if the helper being called has any message resource needs from the container calling it. For example see #validatePaymentMethod(Order, PaymentMethod, Form, MarkupContainer)

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
OrderProcessHelper()
OrderProcessHelper(OrderStrategy orderStrategy, OrderService orderService, EcomUserDaoImpl<GuestUser> userDao)
OrderProcessHelper(OrderStrategy orderStrategy, OrderService orderService, PaymentOptionsStrategy paymentOptionsStrategy, EcomUserDaoImpl<GuestUser> userDao)

Method Summary

Modifier and Type	Method and Description
boolean	allowReuseOfOrder(IGenericEcomUser user, O order) Ensure Order via param injection is valid and secure to re-use
boolean	allowReuseOfOrder(O order) Ensure Order via param injection is valid and secure to re-use
<CONTEXT> CONTEXT	deriveContext(IGenericEcomUser user, org.apache.wicket.RequestCycle requestCycle) Derive the Context from the session Example : Other aspects maybe added to session; like couponCode etc in JSON.
<P extends Product> O	deriveOrder(Map<P,Number> productQuantityMap, IGenericEcomUser user, String currency, Class<org.apache.wicket.Page> pageClass, O existingOrderObject, String orderId, Map itemProperties, boolean persist, org.apache.commons.collections.Transformer transformer, org.apache.wicket.RequestCycle requestCycle, org.apache.wicket.Response response) Derive an order object THIS METHOD IS A HELPER, IT WILL NOT FILL ALL DETAILS LIKE PROMOTIONS, OrderItem specific additional properties etc.
<P extends Product> O	deriveOrder(Map<P,Number> productQuantityMap, IGenericEcomUser user, String currency, Class<org.apache.wicket.Page> pageClass, O existingOrderObject, String orderId, Map itemProperties, org.apache.wicket.RequestCycle requestCycle, org.apache.wicket.Response response) Derive a persistent created or create a persistent order THIS METHOD IS A HELPER, IT WILL NOT FILL ALL DETAILS LIKE PROMOTIONS, OrderItem specific additional properties etc.
String	generatePaymentLink(O order) Generate the purchase order link for the customer using the instance set urlGenerator
String	generatePaymentLink(String baseCheckOutPageAddresss, String userId, String orderId, String salt) Deprecated. @see generatePaymentLink(Order)
ContextProviderStrategy	getContextProviderStrategy()
OrderService	getOrderService()
OrderStrategy	getOrderStrategy()
PaymentOptionsStrategy	getPaymentOptionsStrategy()
OrderURLGeneratorTransformer<O>	getUrlGenerator()
EcomUserDaoImpl<GuestUser>	getUserDao()
String	getVersion() Strategies change; it may be important/required in most applications to know a result based on which version of a particular strategy.
void	setContextProviderStrategy(ContextProviderStrategy contextProviderStrategy)
void	setOrderService(OrderService orderService)
void	setOrderStrategy(OrderStrategy orderStrategy)
void	setPaymentOptionsStrategy(PaymentOptionsStrategy paymentOptionsStrategy)
void	setUrlGenerator(OrderURLGeneratorTransformer<O> urlGenerator)
void	setUserDao(EcomUserDaoImpl<GuestUser> userDao)
boolean	validatePaymentMethod(O order, org.apache.wicket.MarkupContainer feedbackPanel, org.apache.wicket.MarkupContainer resourceContainer) The container component calling this stateless-instance must also include the following Message container resources: error.paymentmethod.invalid error.order.nopaymentmethods

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderProcessHelper

public OrderProcessHelper()

OrderProcessHelper

public OrderProcessHelper(OrderStrategy orderStrategy,
                          OrderService orderService,
                          PaymentOptionsStrategy paymentOptionsStrategy,
                          EcomUserDaoImpl<GuestUser> userDao)

OrderProcessHelper

public OrderProcessHelper(OrderStrategy orderStrategy,
                          OrderService orderService,
                          EcomUserDaoImpl<GuestUser> userDao)

Method Detail

validatePaymentMethod

public boolean validatePaymentMethod(O order,
                                     org.apache.wicket.MarkupContainer feedbackPanel,
                                     org.apache.wicket.MarkupContainer resourceContainer)
                              throws Exception

The container component calling this stateless-instance must also include the following Message container resources:

• error.paymentmethod.invalid
• error.order.nopaymentmethods

Parameters:

order - as O

paymentMethod - as PaymentMethod

feedbackPanel - as MarkupContainer like a form or container that displays error and feedback messages

resourceContainer - as MarkupContainer calling this method and containing the error message resources

Returns:

Throws:

Exception

deriveContext

public <CONTEXT> CONTEXT deriveContext(IGenericEcomUser user,
                                       org.apache.wicket.RequestCycle requestCycle)

Derive the Context from the session Example : Other aspects maybe added to session; like couponCode etc in JSON.

Parameters:

user - as GenericEcomUser

requestCycle - as RequestCycle

Returns:

See Also:

ContentProviderStrategy

deriveOrder

public <P extends Product> O deriveOrder(Map<P,Number> productQuantityMap,
                                         IGenericEcomUser user,
                                         String currency,
                                         Class<org.apache.wicket.Page> pageClass,
                                         O existingOrderObject,
                                         String orderId,
                                         Map itemProperties,
                                         org.apache.wicket.RequestCycle requestCycle,
                                         org.apache.wicket.Response response)
                                  throws OrderPlacementException

Derive a persistent created or create a persistent order
THIS METHOD IS A HELPER, IT WILL NOT FILL ALL DETAILS LIKE PROMOTIONS, OrderItem specific additional properties etc.

Parameters:

productQuantityMap - as Map of Product and the number items for the product

user - as GenericEcomUser making the order

pageClass - @nullable true; if not null, it will redirect page to the pageClass with oid=order_id

existingOrderObject - as Order @nullable true; any Order object that already exists and needs tobe used instead of generating a new one

orderId - as String (but expected number format) - Passed Paremter if existingOrderObject is not to be considered (dont care) and we want to use the parameter to derive the Order object

Map - itemProperties - Map of Product Name to a Map (JSON) of associated properties for it.

Returns:

Order ; may or may not be the same as existingOrderObject

Throws:

OrderPlacementException

deriveOrder

public <P extends Product> O deriveOrder(Map<P,Number> productQuantityMap,
                                         IGenericEcomUser user,
                                         String currency,
                                         Class<org.apache.wicket.Page> pageClass,
                                         O existingOrderObject,
                                         String orderId,
                                         Map itemProperties,
                                         boolean persist,
                                         org.apache.commons.collections.Transformer transformer,
                                         org.apache.wicket.RequestCycle requestCycle,
                                         org.apache.wicket.Response response)
                                  throws OrderPlacementException

Derive an order object
THIS METHOD IS A HELPER, IT WILL NOT FILL ALL DETAILS LIKE PROMOTIONS, OrderItem specific additional properties etc.

Parameters:

productQuantityMap - as Map of Product and the number items for the product

user - as GenericEcomUser making the order

pageClass - @nullable true; if not null, it will redirect page to the pageClass with oid=order_id

existingOrderObject - as Order @nullable true; any Order object that already exists and needs tobe used instead of generating a new one

orderId - as String (but expected number format) - Passed Paremter if existingOrderObject is not to be considered (dont care) and we want to use the parameter to derive the Order object

Map - itemProperties - Map of Product Name to a Map (JSON) of associated properties for it.

persist - as boolean.

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

Returns:

Order ; may or may not be the same as existingOrderObject

Throws:

OrderPlacementException

allowReuseOfOrder

public boolean allowReuseOfOrder(IGenericEcomUser user,
                                 O order)

Ensure Order via param injection is valid and secure to re-use

Parameters:

user - as GenericEcomUser

order - as Order

Returns:

boolean; true is re-use permitted for another Transaction or scenario

allowReuseOfOrder

public boolean allowReuseOfOrder(O order)

Ensure Order via param injection is valid and secure to re-use

Parameters:

order - as Order

Returns:

boolean; true is re-use permitted for another Transaction or scenario

generatePaymentLink

@Deprecated
public String generatePaymentLink(String baseCheckOutPageAddresss,
                                              String userId,
                                              String orderId,
                                              String salt)

Deprecated. @see generatePaymentLink(Order)

Context insensitive Link that will allow any user to make payment on the given Link (if the site supports this feature)
This API provides a consistent convention and any Order request page created should respect the convention defined here or by any overriding method.
THIS METHOD IS PURELY FOR PROVIDING CONVENTION

Parameters:

baseCheckOutPageAddresss - as page base URL

userId - as GenericEcomUser

orderId - as Order

salt - as String (optional security code)

Returns:

generatePaymentLink

public String generatePaymentLink(O order)

Generate the purchase order link for the customer using the instance set urlGenerator

Parameters:

order - as O

Returns:

String as URL

getOrderStrategy

public OrderStrategy getOrderStrategy()

setOrderStrategy

public void setOrderStrategy(OrderStrategy orderStrategy)

getOrderService

public OrderService getOrderService()

setOrderService

public void setOrderService(OrderService orderService)

getPaymentOptionsStrategy

public PaymentOptionsStrategy getPaymentOptionsStrategy()

setPaymentOptionsStrategy

public void setPaymentOptionsStrategy(PaymentOptionsStrategy paymentOptionsStrategy)

getUserDao

public EcomUserDaoImpl<GuestUser> getUserDao()

setUserDao

public void setUserDao(EcomUserDaoImpl<GuestUser> userDao)

getContextProviderStrategy

public ContextProviderStrategy getContextProviderStrategy()

setContextProviderStrategy

public void setContextProviderStrategy(ContextProviderStrategy contextProviderStrategy)

getUrlGenerator

public OrderURLGeneratorTransformer<O> getUrlGenerator()

setUrlGenerator

public void setUrlGenerator(OrderURLGeneratorTransformer<O> urlGenerator)

getVersion

public String getVersion()

Strategies change; it may be important/required in most applications to know a result based on which version of a particular strategy.
Every strategy is required to return its version id.

Specified by:

getVersion in interface Strategy

Returns:

String @nullable true if default/not required