com.neurosys.ecom.strategy.service

Class AbstractChargeStrategy<P extends Product,U extends User>

java.lang.Object

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

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

Type Parameters:

P -

U -

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultDiscountStrategy, DefaultOrderStrategy, DefaultPackagingStrategy, DefaultPromotionStrategy, DefaultSaleStrategy, DefaultShippingStrategy, DefaultTaxStrategy

public abstract class AbstractChargeStrategy<P extends Product,U extends User>
extends AbstractStrategy<P,U>
implements CumulativeChargeStrategy<P,U>

Default Strategy implementation for all ChargeStrategy

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected TaxStrategy	taxStrategy Tax can be factored into any other Strategy, so providing by default

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

productService, scanHierarchy

Constructor Summary

Constructors

Constructor and Description
AbstractChargeStrategy()

Method Summary

Modifier and Type	Method and Description
protected void	applyTax(Amount amt, P product) Convenience method for applying tax over individual strategies
<CONTEXT> Amount	calculate(Map<P,Number> productQtyMap, U user, String currency, List<PromotionForUser> promotions, Amount subTotal, Number quantityTotal, CONTEXT context) Calculate raw amount for product(s)
TaxStrategy	getTaxStrategy() Tax can be factored into any other Strategy, so providing by default
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	setTaxStrategy(TaxStrategy taxStrategy) Tax can be factored into any other Strategy, so providing by default

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.ChargeStrategy

calculate

Field Detail

taxStrategy

protected TaxStrategy taxStrategy

Tax can be factored into any other Strategy, so providing by default

Can be null:

true

Constructor Detail

AbstractChargeStrategy

public AbstractChargeStrategy()

Method Detail

applyTax

protected void applyTax(Amount amt,
                        P product)

Convenience method for applying tax over individual strategies

Parameters:

amt - as Amount

product - as P

calculate

public <CONTEXT> Amount calculate(Map<P,Number> productQtyMap,
                                  U user,
                                  String currency,
                                  List<PromotionForUser> promotions,
                                  Amount subTotal,
                                  Number quantityTotal,
                                  CONTEXT context)

Description copied from interface: CumulativeChargeStrategy

Calculate raw amount for product(s)

Specified by:

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

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

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:

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

getTaxStrategy

public TaxStrategy getTaxStrategy()

Tax can be factored into any other Strategy, so providing by default

Can be null:

true

setTaxStrategy

public void setTaxStrategy(TaxStrategy taxStrategy)

Tax can be factored into any other Strategy, so providing by default

Can be null:

true

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