com.neurosys.ecom.cart.service

Interface CartService<P extends Product,SESSION,REQUEST,USER>

All Superinterfaces:

ChangeGenerator<Object>

All Known Implementing Classes:

AbstractCartService, ServletCartService, WicketCartService

public interface CartService<P extends Product,SESSION,REQUEST,USER>
extends ChangeGenerator<Object>

Basic services around the Cart

Also supports ChangeGenerator

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	CART_TYPE_SHOPPING
static String	CART_TYPE_WISHLIST

Method Summary

Modifier and Type	Method and Description
void	actionOnUpdateCartType(SESSION session, REQUEST request, String cartType, Cart cart) Updating cart to Session or Persistence.
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(SESSION 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.
String	getCartSessionId(SESSION session, String cartType) A client cart is identified by its user name (primary) and a sessionId (for session based carts like shopping cart).
String	getCartUserId(SESSION session, USER user, String cartType) A client cart is identified by its user name (primary) and a sessionId (for session based carts like shopping cart).
Cart	mergeCarts(SESSION session, String cartType, Cart existingCart, Cart newSubCart) Some operations require sub-carts to be added/merged with an existing Cart.
Cart	saveCart(String type, Cart cart, SESSION session, REQUEST request) Save the Cart to persist so it can be retrieved using getCartForUser(String, String)
Cart	subtractCart(SESSION session, String cartType, Cart existingCart, Cart cartToBeSubtracted) This operation will remove a cart from the existingCart
void	validateCart(Cart cart, SESSION session) Validate requested Stock positions in the Cart etc.

Methods inherited from interface com.neurosys.events.ChangeGenerator

addChangeListener, getListeners, notifyAllListeners, setListeners

Field Detail

CART_TYPE_SHOPPING

static final String CART_TYPE_SHOPPING

See Also:

Constant Field Values

CART_TYPE_WISHLIST

static final String CART_TYPE_WISHLIST

See Also:

Constant Field Values

Method Detail

getCartForUser

Cart getCartForUser(String userId,
                    String type)

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

Parameters:

userId - as String

type - as String

Returns:

Cart

getCartForSession

Cart getCartForSession(SESSION session,
                       String type)

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

Parameters:

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

Returns:

saveCart

Cart saveCart(String type,
              Cart cart,
              SESSION session,
              REQUEST request)
       throws Exception

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

Parameters:

cart - as Cart

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

request - as REQUEST

Returns:

Cart

Throws:

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

validateCart

void validateCart(Cart cart,
                  SESSION session)
           throws Exception

Validate requested Stock positions in the Cart etc.

Parameters:

cart - as Cart

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

Throws:

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

convertToProductQuantityMap

Map<P,Number> convertToProductQuantityMap(Cart cart)

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.

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

List<P> convertToProductList(Cart cart)

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.

Parameters:

cart - as Cart

Returns:

List of products

mergeCarts

Cart mergeCarts(SESSION 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.

Parameters:

session - as SESSION impl like EComSession

cartType - as String

existingCart - as Cart

newCart - as Cart

Returns:

Cart

subtractCart

Cart subtractCart(SESSION session,
                  String cartType,
                  Cart existingCart,
                  Cart cartToBeSubtracted)

This operation will remove a cart from the existingCart

Parameters:

session - as SESSION impl like EComSession

cartType - as String

existingCart - as Cart

cartToBeSubtracted - as Cart

Returns:

Cart

actionOnUpdateCartType

void actionOnUpdateCartType(SESSION session,
                            REQUEST request,
                            String cartType,
                            Cart cart)
                     throws Exception

Updating cart to Session or Persistence.
Determine action based on type of Cart

Parameters:

session - as SESSION impl like EComSession

cartType - as String

cart - as Cart @nullable true. If true it imples we are Clearing the cart

Throws:

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

getCartUserId

String getCartUserId(SESSION session,
                     USER user,
                     String cartType)

A client cart is identified by its user name (primary) and a sessionId (for session based carts like shopping cart).
This method allows to generate which user attribute will define the userId for the cart.

Parameters:

session - as SESSION

user - as USER

cartType - as String

Returns:

userId as String

getCartSessionId

String getCartSessionId(SESSION session,
                        String cartType)

A client cart is identified by its user name (primary) and a sessionId (for session based carts like shopping cart).
This method allows to generate a unique session Id from the session.
Since the sessionId is persisted on the client-cart and the duration is purely client implementation dependent, it maybe prudent not to directly use a sessionId if proper cleanup mechanisms are not in place once a session has ended on the client side.

Parameters:

session - as SESSION

cartType - as String

Returns:

sessionId as String