com.neurosys.ecom.strategy.service

Class DefaultPromotionStrategy<P extends Product,U extends IGenericEcomUser>

java.lang.Object

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

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

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

Type Parameters:

P - as Product

U - as AbstractUser

All Implemented Interfaces:

ChargeStrategy<P,U>, CumulativeChargeStrategy<P,U>, PromotionStrategy<P,U>, Strategy

public class DefaultPromotionStrategy<P extends Product,U extends IGenericEcomUser>
extends AbstractChargeStrategy<P,U>
implements PromotionStrategy<P,U>

PromotionStrategy for this application
This default impl assumes a context of Object[0] = email, Object[1] = couponCode

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static MarshalUtils.GenericTransformer<PromotionForUser,String>	PROMOTION_STRING_TRANSFORMER Create a Notation - PromotionName:UserId:CouponCode
protected PromotionService<Promotion>	promotionService
static MarshalUtils.GenericTransformer<String,PromotionForUser>	STRING_PROMOTION_TRANSFORMER Read the Notation - PromotionName:UserId:CouponCode to produce a PromotionForUser transient object

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
DefaultPromotionStrategy()

Method Summary

Modifier and Type	Method and Description
<CONTEXT> Amount	calculate(Map<P,Number> productQtyMap, U user, String currency, List<PromotionForUser> promotions, Amount subTotal, Number totalQuantity, CONTEXT context) Calculate raw amount for product(s)
<CONTEXT> Amount	calculate(P product, Number quantity, U user, String currency, List<PromotionForUser> promotions, CONTEXT context) By default this Strategy does not do anything @ a product level.
void	commitPromotionsForOrder(Order order) Update Promotions persisted state; to track count, usage of promotion etc.
protected Amount	discountForPromotion(PromotionForUser promotionForUser, Map<P,Number> productQtyMap, String currency, Amount subTotal)
protected <CONTEXT> String	getCouponCode(CONTEXT context) By default uses context[0][1]
<CONTEXT> List<PromotionForUser>	getPromotions(Map<P,Number> productQtyMap, U user, Amount subTotal, Number quantityTotal, CONTEXT context) Note: Default implementation looks for any item not on SALE to grant the Discount.
protected List<PromotionForUser>	getPromotions(String userEmail, String couponCode)
PromotionService<Promotion>	getPromotionService()
protected <CONTEXT> String	getUserEmailOrId(CONTEXT context) By default uses context[0][0]
protected Double	includeProductPriceForDiscount(P p, PromotionForUser promotionForUser, String currency, Amount subTotal) If this returns a double then in cases where the Discount is variable on the Cart amount; this will contribute.
void	setPromotionService(PromotionService<Promotion> promotionService)
protected <CONTEXT> void	validate(Map<P,Number> productQtyMap, String userEmail, String couponCode, CONTEXT context) (Default impl) does nothing.
protected void	validate(PromotionForUser promotionForUser, String currency, Amount subTotal, Number totalQuantity)

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

applyTax, 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

promotionService

protected PromotionService<Promotion> promotionService

PROMOTION_STRING_TRANSFORMER

public static final MarshalUtils.GenericTransformer<PromotionForUser,String> PROMOTION_STRING_TRANSFORMER

Create a Notation - PromotionName:UserId:CouponCode

STRING_PROMOTION_TRANSFORMER

public static final MarshalUtils.GenericTransformer<String,PromotionForUser> STRING_PROMOTION_TRANSFORMER

Read the Notation - PromotionName:UserId:CouponCode to produce a PromotionForUser transient object

Constructor Detail

DefaultPromotionStrategy

public DefaultPromotionStrategy()

Method Detail

getPromotions

protected List<PromotionForUser> getPromotions(String userEmail,
                                               String couponCode)

getUserEmailOrId

protected <CONTEXT> String getUserEmailOrId(CONTEXT context)

By default uses context[0][0]

Parameters:

context - with first vararg as Object[] in default implementation, can override to anything

Returns:

String identifying user for the coupon

getCouponCode

protected <CONTEXT> String getCouponCode(CONTEXT context)

By default uses context[0][1]

Parameters:

context - with first vararg as Object[] in default implementation, can override to anything

Returns:

String identifying provided coupon code

validate

protected <CONTEXT> void validate(Map<P,Number> productQtyMap,
                                  String userEmail,
                                  String couponCode,
                                  CONTEXT context)
                           throws javax.validation.ValidationException

(Default impl) does nothing.

Throws:

javax.validation.ValidationException - ; Soft fail, by throwing ValidationException

getPromotions

public <CONTEXT> List<PromotionForUser> getPromotions(Map<P,Number> productQtyMap,
                                                      U user,
                                                      Amount subTotal,
                                                      Number quantityTotal,
                                                      CONTEXT context)
                                               throws javax.validation.ValidationException

Note: Default implementation looks for any item not on SALE to grant the Discount. SALE is not applicable on SALE items.
However, there is a catch. If the NON SALE item value is lower than the DISCOUNT offered on the Cart then in effect the discount is offered is higher than value of NON-SALE item. but this is more liberal. ... upto Business what they want!
Override to customize business logic.

Specified by:

getPromotions in interface PromotionStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

productQtyMap - as Map of Product to Number (Quantity)

user - as U @NUllable true

subTotal - as Amount; many scenarios use the Sub-Total of products to calculate other params. So provide that as a defined context variable. @nullable true

quantityTotal - as Number; many scenarios use the quantityTotal of products to calculate other params @nullable true

context - as additional case driven params that can be supplied @nullable true

Returns:

List of PromotionForUser . @Nulable true; No promotions available

Throws:

javax.validation.ValidationException

validate

protected void validate(PromotionForUser promotionForUser,
                        String currency,
                        Amount subTotal,
                        Number totalQuantity)
                 throws Continue,
                        javax.validation.ValidationException

Throws:

Continue

javax.validation.ValidationException

includeProductPriceForDiscount

protected Double includeProductPriceForDiscount(P p,
                                                PromotionForUser promotionForUser,
                                                String currency,
                                                Amount subTotal)

If this returns a double then in cases where the Discount is variable on the Cart amount; this will contribute. If null then wil be skipped from discount.
For example: We may want to exclude NON-SALE items from TOTAL, so in that case for the product null can be returned. Or in multi-currency, we want the amount to vary based on subTotal Amount.getCurrency().

By default it will return final Price

Parameters:

p - as Product

promotionForUser - as PromotionForUser

currency - as String

subTotal - as Amount

Returns:

null if no discount else a Double value

discountForPromotion

protected Amount discountForPromotion(PromotionForUser promotionForUser,
                                      Map<P,Number> productQtyMap,
                                      String currency,
                                      Amount subTotal)

calculate

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

By default this Strategy does not do anything @ a product level. See DefaultDiscountStrategy for that.

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)

calculate

public <CONTEXT> Amount calculate(Map<P,Number> productQtyMap,
                                  U user,
                                  String currency,
                                  List<PromotionForUser> promotions,
                                  Amount subTotal,
                                  Number totalQuantity,
                                  CONTEXT context)
                           throws javax.validation.ValidationException

Description copied from interface: CumulativeChargeStrategy

Calculate raw amount for product(s)

Specified by:

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

Specified by:

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

Overrides:

calculate in class AbstractChargeStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

productQtyMap - as Map of Product to Number (Quantity)

user - as U @NUllable true

currency - as String @nullable true. A null implies default currency. Note: If not null then this will override subTotal Amount.getCurrency().

subTotal - as Amount; many scenarios use the Sub-Total of products to calculate other params. So provide that as a defined context variable. @nullable true

totalQuantity - as Number; many scenarios use the quantityTotal of products to calculate other params @nullable true

context - as additional case driven params that can be supplied @nullable true

Returns:

Amount @nullable true (implementation dependent) For Promotions; if there is a discount then Amount.getTotal() should be positive; while Amount.getDiscount() should be negative number. This is because a Discount is DEDUCTED. So while it makes sense to DEDUCT a positive value from TOTAL; the discount itself should be ADDED hence = > Existing Total - (This Discount as Total) Existing Discount - (-This Discount) = Existing Discount + This Discount

Throws:

javax.validation.ValidationException

See Also:

Amount.deduct(Amount)

commitPromotionsForOrder

@Transactional(readOnly=false)
public void commitPromotionsForOrder(Order order)

Update Promotions persisted state; to track count, usage of promotion etc. by user/order. If there are any Promotion's mentioned in the Order then commit them to Data Store.
For example if a COUPON is to be used only N times; then ensure after the Order is successful the validity is reduced to N-1 Update Promotions persisted state; to track count, usage of promotion etc. by user/order.

Specified by:

commitPromotionsForOrder in interface PromotionStrategy<P extends Product,U extends IGenericEcomUser>

getPromotionService

public PromotionService<Promotion> getPromotionService()

setPromotionService

public void setPromotionService(PromotionService<Promotion> promotionService)