com.neurosys.ecom.strategy.service

Class DefaultSaleStrategy<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>

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

All Implemented Interfaces:

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

public class DefaultSaleStrategy<P extends Product,U extends User>
extends AbstractChargeStrategy<P,U>
implements SaleStrategy<P,U>

By Default simple process the data coming and spit it back out.
provides a place holder for intercepting data and applying future strategies.

All locking is done @ the sessionId level

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected LockStrategy<P,U>	lockStrategy

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

Method Summary

Modifier and Type	Method and Description
void	actionOnPurchase(List<P> product, U user, String sessionId) On an event where a User made a purchase
void	actionOnRating(P product, U user, String sessionId) On user Rating; if there is rating ability then any custom action
void	actionOnVisit(P product, U user, String sessionId) On an event where a User visited the products
protected <CONTEXT> void	applyDiscount(Amount amt, P product, Number quantity, U user, List<PromotionForUser> promotions, CONTEXT context) Apply discount on product.
protected <CONTEXT> void	applyTax(Amount amt, P product, Number quantity, U user, String currency, List<PromotionForUser> promotions, CONTEXT context)
<CONTEXT> List<Boolean>	areProductsAvailableToBeSold(List<P> products, U user, String sessionId, CONTEXT context) Are these products for Sale
<CONTEXT> Amount	calculate(P product, Number quantity, U user, String currency, List<PromotionForUser> promotions, CONTEXT context) Calculate Amount for product in the given context.
protected Amount	getDefaultAmtForMissingData(Price price) If any amount is null due to data missing; then what should be returned.
LockStrategy<P,U>	getLockStrategy() An optional LockStrategy
<CONTEXT> Price	getPrice(P product, U user, CONTEXT context) Override to customize which price is used, in case of multi-currency variable pricing etc.
Number	getUnitsInStock(P product, U user, String sessionId) Get the number of units in Stock available for purchase.
<CONTEXT> Boolean	isProductAvailableToBeSold(P product, U user, String sessionId, CONTEXT context) The product is not for sale, if Product.getCurrentInventory() <= 0 or the Product.getRegularPrice() is 0 or null.
void	setLockStrategy(LockStrategy<P,U> lockStrategy) An optional LockStrategy
protected Double	validateFinalPrice(P product, Double finalPrice) Validation to perform checks to make it fool-proof like avoid making stupid mistakes like Zero products etc.

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

calculate

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

getVersion

Field Detail

lockStrategy

protected LockStrategy<P extends Product,U extends User> lockStrategy

Constructor Detail

DefaultSaleStrategy

public DefaultSaleStrategy()

Method Detail

applyDiscount

protected <CONTEXT> void applyDiscount(Amount amt,
                                       P product,
                                       Number quantity,
                                       U user,
                                       List<PromotionForUser> promotions,
                                       CONTEXT context)

Apply discount on product. Example a project may consider a product being on SALE itself to be a discount (difference between regular and sale price). By default nothing happens.

Parameters:

amt - as Amount

product - as P

quantity - as Number

user - as U

promotions - as List of Promotions

context - as Object...

applyTax

protected <CONTEXT> void applyTax(Amount amt,
                                  P product,
                                  Number quantity,
                                  U user,
                                  String currency,
                                  List<PromotionForUser> promotions,
                                  CONTEXT context)

validateFinalPrice

protected Double validateFinalPrice(P product,
                                    Double finalPrice)
                             throws javax.validation.ValidationException

Validation to perform checks to make it fool-proof like avoid making stupid mistakes like Zero products etc. By default does nothing.

Parameters:

finalPrice -

Returns:

Throws:

javax.validation.ValidationException

getPrice

public <CONTEXT> Price getPrice(P product,
                                U user,
                                CONTEXT context)

Override to customize which price is used, in case of multi-currency variable pricing etc.

Returns:

Price

getDefaultAmtForMissingData

protected Amount getDefaultAmtForMissingData(Price price)

If any amount is null due to data missing; then what should be returned.

Parameters:

price - as Price

Returns:

Amount

Default value:

null

calculate

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

Calculate Amount for product in the given context.
By default the Amount.getBase() is considered the total with regular price without discounts

Specified by:

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

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)

See Also:

#getPrices(Product, User, Object...)

isProductAvailableToBeSold

public <CONTEXT> Boolean isProductAvailableToBeSold(P product,
                                                    U user,
                                                    String sessionId,
                                                    CONTEXT context)

The product is not for sale, if Product.getCurrentInventory() <= 0 or the Product.getRegularPrice() is 0 or null.
Note: Sale Price is not considered by default, as it may be 0 or null since it wont be specified for a lot of products perhaps and even if so, one could give away free items on discount if applicable. Basically an NA for consideration, hence only regular price is being considered for most scenarios.

Specified by:

isProductAvailableToBeSold in interface SaleStrategy<P extends Product,U extends User>

Parameters:

product - as P

user - as U @nullable true

Returns:

areProductsAvailableToBeSold

public <CONTEXT> List<Boolean> areProductsAvailableToBeSold(List<P> products,
                                                            U user,
                                                            String sessionId,
                                                            CONTEXT context)

Description copied from interface: SaleStrategy

Are these products for Sale

Specified by:

areProductsAvailableToBeSold in interface SaleStrategy<P extends Product,U extends User>

Parameters:

products - as List of P

user - as U @nullable true

Returns:

List of boolean values corresponding to each input @nullable true

getUnitsInStock

public Number getUnitsInStock(P product,
                              U user,
                              String sessionId)

Description copied from interface: SaleStrategy

Get the number of units in Stock available for purchase. Also provide the User as a parameter ; incase the strategy wants to factor which user has how much available to them.

Specified by:

getUnitsInStock in interface SaleStrategy<P extends Product,U extends User>

Parameters:

product - as P

user - as U @nullable true

sessionId - as String @nullable true

Returns:

actionOnPurchase

public void actionOnPurchase(List<P> product,
                             U user,
                             String sessionId)

Description copied from interface: SaleStrategy

On an event where a User made a purchase

Specified by:

actionOnPurchase in interface SaleStrategy<P extends Product,U extends User>

actionOnVisit

public void actionOnVisit(P product,
                          U user,
                          String sessionId)

Description copied from interface: SaleStrategy

On an event where a User visited the products

Specified by:

actionOnVisit in interface SaleStrategy<P extends Product,U extends User>

Parameters:

product - as P

user - as U

actionOnRating

public void actionOnRating(P product,
                           U user,
                           String sessionId)

Description copied from interface: SaleStrategy

On user Rating; if there is rating ability then any custom action

Specified by:

actionOnRating in interface SaleStrategy<P extends Product,U extends User>

Parameters:

product - as P

user - as U

getLockStrategy

public LockStrategy<P,U> getLockStrategy()

An optional LockStrategy

Specified by:

getLockStrategy in interface SaleStrategy<P extends Product,U extends User>

Returns:

LockStrategy @nullable true

setLockStrategy

public void setLockStrategy(LockStrategy<P,U> lockStrategy)

An optional LockStrategy

Parameters:

LockStrategy - @nullable true