com.neurosys.ecom.cart.service

Class AbstractCartService<P extends Product,S,R,U extends User>

java.lang.Object

com.neurosys.ecom.cart.service.AbstractCartService<P,S,R,U>

All Implemented Interfaces:

CartService<P,S,R,U>, ChangeGenerator<Object>

Direct Known Subclasses:

ServletCartService, WicketCartService

public abstract class AbstractCartService<P extends Product,S,R,U extends User>
extends Object
implements CartService<P,S,R,U>

Basic implementation for CartService uses SESSION. It assumes CartItem.getName() as he Key, however if you wish to override, look @ CartItem.getKey(), #getProductKey(Product), #getProductsForKeys(Collection), StrategiesService.strategiesCalcData(List, IGenericEcomUser, String, String, Collection, com.neurosys.ecom.wicket.components.EComSession, String).

Since this implements ChangeGenerator; it will also generate Events of Type

• On Any change - Object[]{String cartType, Cart, sessionId as String, (optional) CartService method name}
• On Any operation UPDATE/INSERT/REMOVE - Object[]{String cartType, Cart existingCart, Cart cartForOperation, sessionId as String, String operationName}

Author:

Arjun Dhar

See Also:

CartProductTransformService

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	persistSessionCarts If true, will persist session carts until they are cleared (On Action where cart is null or blank).
protected SaleStrategy<P,U>	saleStrategy When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence

Fields inherited from interface com.neurosys.ecom.cart.service.CartService

CART_TYPE_SHOPPING, CART_TYPE_WISHLIST

Constructor Summary

Constructors

Constructor and Description
AbstractCartService()
AbstractCartService(ProductService<P> productService)

Method Summary

Modifier and Type	Method and Description
void	actionOnUpdateCartType(S session, R request, String cartType, Cart cart) The required data is extracted from the form, one can script their action on the type of cart here.
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
List<P>	convertToProductList(Cart cart) Convert a given Cart to a Product List.
Map<P,Number>	convertToProductQuantityMap(Cart cart) Convert a given Cart to a Product Quantity Map.
Cart	getCartForSession(S _session, String type) Some carts like Shopping may exist in Session or persisted.
Cart	getCartForUser(String userId, String type) Some carts like a WishList maybe persistent so allow to retrieve it.
protected abstract Cart	getCartFromSession(S session) The Session is expected to be related to the Cart it carries.
CartProductTransformService<P,CartItem>	getCartProductTransform() Handle All conversions
List<ChangeListener<Object>>	getListeners() Get list directly.
protected abstract String	getOrigin(S session, R request) Get the origin of the user Request
ProductService<P>	getProductService()
SaleStrategy<P,U>	getSaleStrategy() When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence
protected abstract String	getSessionId(S session) Get the Id associated with the Session
protected abstract U	getUser(S session) Get the User associated with the Session
UserAttributesDao<UserAttribute>	getUserAttributeDao()
protected abstract String	getUserId(S session) Get the User Id associated with the Session
boolean	isPersistSessionCarts() If true, will persist session carts until they are cleared (On Action where cart is null or blank).
Cart	mergeCarts(S session, String cartType, Cart existingCart, Cart newSubCart) Some operations require sub-carts to be added/merged with an existing Cart.
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
Cart	saveCart(String type, Cart cart, S session, R request) Save the Cart to persist so it can be retrieved using CartService.getCartForUser(String, String)
void	setCartProductTransform(CartProductTransformService<P,CartItem> cartProductTransform) Handle All conversions
protected abstract void	setCartToSession(S session, Cart c) The Session is expected to be related to the Cart it carries.
void	setListeners(List<ChangeListener<Object>> listeners) Set list directly.
void	setPersistSessionCarts(boolean persistSessionCarts) If true, will persist session carts until they are cleared (On Action where cart is null or blank).
void	setProductService(ProductService<P> productService)
void	setSaleStrategy(SaleStrategy<P,U> saleStrategy) When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence
void	setUserAttributeDao(UserAttributesDao<UserAttribute> userAttributeDao)
Cart	subtractCart(S session, String cartType, Cart existingCart, Cart cartToBeSubtracted) This operation will remove a cart from the existingCart
void	validateCart(Cart cart, S session) Validate requested Stock positions in the Cart etc.

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.cart.service.CartService

getCartSessionId, getCartUserId

Field Detail

saleStrategy

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

When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence

persistSessionCarts

protected boolean persistSessionCarts

If true, will persist session carts until they are cleared (On Action where cart is null or blank). Useful to track Abandoned carts

Default value:

false

Constructor Detail

AbstractCartService

public AbstractCartService()

AbstractCartService

public AbstractCartService(ProductService<P> productService)

Method Detail

getSessionId

protected abstract String getSessionId(S session)

Get the Id associated with the Session

Parameters:

session - as SESSION

Returns:

getUserId

protected abstract String getUserId(S session)

Get the User Id associated with the Session

Parameters:

session - as SESSION

Returns:

getUser

protected abstract U getUser(S session)

Get the User associated with the Session

Parameters:

session - as SESSION

Returns:

getOrigin

protected abstract String getOrigin(S session,
                                    R request)

Get the origin of the user Request

Parameters:

session - as SESSION

Returns:

setCartToSession

protected abstract void setCartToSession(S session,
                                         Cart c)

The Session is expected to be related to the Cart it carries. Ability to Get that.

Parameters:

session - as SESSION

getCartFromSession

protected abstract Cart getCartFromSession(S session)

The Session is expected to be related to the Cart it carries. Ability to Set that.

Parameters:

session - as SESSION

Returns:

getCartForUser

public Cart getCartForUser(String userId,
                           String type)

Description copied from interface: CartService

Some carts like a WishList maybe persistent so allow to retrieve it.

Specified by:

getCartForUser in interface CartService<P extends Product,S,R,U extends User>

Parameters:

userId - as String

type - as String

Returns:

Cart

getCartForSession

public Cart getCartForSession(S _session,
                              String type)

Description copied from interface: CartService

Some carts like Shopping may exist in Session or persisted.
So allow a dynamic priority based mechanism or retrieving the Cart

Specified by:

getCartForSession in interface CartService<P extends Product,S,R,U extends User>

Parameters:

_session - as type extends Object (meant to be a Context or Session Object)

Returns:

saveCart

public Cart saveCart(String type,
                     Cart cart,
                     S session,
                     R request)

Description copied from interface: CartService

Save the Cart to persist so it can be retrieved using CartService.getCartForUser(String, String)

Specified by:

saveCart in interface CartService<P extends Product,S,R,U extends User>

cart - as Cart

session - as type extends Object (meant to be a Context or Session Object) @nullable true

request - as REQUEST

Returns:

Cart

convertToProductQuantityMap

public Map<P,Number> convertToProductQuantityMap(Cart cart)

Description copied from interface: CartService

Convert a given Cart to a Product Quantity Map.
The cart only contains references to the actual Product entities. This method one to derive the full map from the Cart reference data.

One may not always assume quantity to be an Integer, hence Number is used. While default implementations will assume INteger values (like WicketCartService), one may write their own implementation to use a more appropriate format if necessary.

Specified by:

convertToProductQuantityMap in interface CartService<P extends Product,S,R,U extends User>

Parameters:

cart - as Cart

Returns:

Map of Product to Item Quantity

See Also:

to get {@link Cart#getItems()} as this Map isnt scalable; like hierarchy info etc. This is ok for a flat list of all items and their quantity in a {@link Cart}

convertToProductList

public List<P> convertToProductList(Cart cart)

Description copied from interface: CartService

Convert a given Cart to a Product List. (with repeats if multiple quantities of the product exist in the Cart)
The cart only contains references to the actual Product entities. This method one to derive the full map from the Cart reference data.

Specified by:

convertToProductList in interface CartService<P extends Product,S,R,U extends User>

Parameters:

cart - as Cart

Returns:

List of products

validateCart

public void validateCart(Cart cart,
                         S session)
                  throws Exception

Validate requested Stock positions in the Cart etc.
Note: If there is no saleStrategy and Product.getCurrentInventory() is NULL (not 0 but strictly NULL), then it will skip the inventory check for that product.

Specified by:

validateCart in interface CartService<P extends Product,S,R,U extends User>

Parameters:

cart - as Cart

session - as SESSION @nullable true

Throws:

Exception - - In case of some validation exception etc while accepting the Cart

mergeCarts

public Cart mergeCarts(S session,
                       String cartType,
                       Cart existingCart,
                       Cart newSubCart)

Some operations require sub-carts to be added/merged with an existing Cart. (INTERSECTION)
This defines the merge operation. This implementation will update the products provided in the newSubCart that already existing and add the ones that don't.
It will leave existing products unaffected that are there in the existingCart and not mentioned in newSubCart.
This operation will also try to maintain the order in the existingCart for the existing items. The modified and new will come @ the end of the List

In addition to the basic products a Cart may contain additional details like Cart.getCurrency(). In this case the default expected behavior is defined as the latest/update overwriting the previouscart property.

Specified by:

mergeCarts in interface CartService<P extends Product,S,R,U extends User>

Parameters:

session - as SESSION - unused; passed onto Event Handler

cartType - as String - unused; passed onto Event Handler

existingCart - as Cart @nullable false; but cart can be empty

newSubCart - as Cart @nullable true

Returns:

Cart ; this implementation this is the same as existingCart Object

subtractCart

public Cart subtractCart(S session,
                         String cartType,
                         Cart existingCart,
                         Cart cartToBeSubtracted)

This operation will remove a cart from the existingCart
In this implementation; a single mention of a the to-be-removed product will remove all product instances from the cart.
This operation will also try to maintain the order in the existingCart for the existing items.

Specified by:

subtractCart in interface CartService<P extends Product,S,R,U extends User>

Parameters:

session - as SESSION - unused; passed onto Event Handler

cartType - as String - unused; passed onto Event Handler

existingCart - as Cart @nullable false; but cart can be empty

cartToBeSubtracted - as Cart @nullable true
TODO: Add unit test case

Returns:

Cart

actionOnUpdateCartType

public void actionOnUpdateCartType(S session,
                                   R request,
                                   String cartType,
                                   Cart cart)
                            throws Exception

The required data is extracted from the form, one can script their action on the type of cart here.

Specified by:

actionOnUpdateCartType in interface CartService<P extends Product,S,R,U extends User>

Parameters:

cartType - as String

cart - as Cart

session - as SESSION impl like EComSession

Throws:

Exception - - In case of some validation exception etc while accepting the Cart

getProductService

public ProductService<P> getProductService()

setProductService

public void setProductService(ProductService<P> productService)

getUserAttributeDao

public UserAttributesDao<UserAttribute> getUserAttributeDao()

setUserAttributeDao

public void setUserAttributeDao(UserAttributesDao<UserAttribute> userAttributeDao)

isPersistSessionCarts

public boolean isPersistSessionCarts()

If true, will persist session carts until they are cleared (On Action where cart is null or blank). Useful to track Abandoned carts

Default value:

false

setPersistSessionCarts

public void setPersistSessionCarts(boolean persistSessionCarts)

If true, will persist session carts until they are cleared (On Action where cart is null or blank). Useful to track Abandoned carts

Default value:

false

getSaleStrategy

public SaleStrategy<P,U> getSaleStrategy()

When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence

setSaleStrategy

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

When allowing to add items to cart, if a saleStrategy is provided it will rely on it rather than actual inventory data available from persistence

getCartProductTransform

public CartProductTransformService<P,CartItem> getCartProductTransform()

Handle All conversions

See Also:

CartProductTransformService

setCartProductTransform

public void setCartProductTransform(CartProductTransformService<P,CartItem> cartProductTransform)

Handle All conversions

See Also:

CartProductTransformService

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object>

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object>

getListeners

public List<ChangeListener<Object>> getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object>

setListeners

public void setListeners(List<ChangeListener<Object>> listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object>