com.konakart.al

Class BasketMgr

java.lang.Object

com.konakart.al.BaseMgr

com.konakart.al.BasketMgr

public class BasketMgr
extends BaseMgr

Contains methods to add and remove products from the shopping basket.

Field Summary

Fields inherited from class com.konakart.al.BaseMgr

eng, kkAppEng

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasketMgr(com.konakart.appif.KKEngIf eng, KKAppEng kkAppEng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addToBasket(com.konakart.appif.BasketIf item, boolean refresh) Saves a new Basket object in the database for the current customer.
void	addToBasketWithOptions(com.konakart.appif.BasketIf item, com.konakart.appif.AddToBasketOptionsIf options, boolean refresh) Saves a new Basket object in the database for the current customer.
void	emptyBasket() All items in the basket are removed from the database and the array of basket items for the current customer, are deleted.
com.konakart.appif.AddToBasketOptionsIf	getAddToBasketOptions() Creates an AddToBasketOptionsIf based on the current FetchProductOptions stored in the AppEng.
void	getBasketItemsPerCustomer() Get the basket items for a customer and language and set them on the customer customer object of the customerMgr.
java.math.BigDecimal	getBasketTotal() Returns the total price of the basket as a BigDecimalValue
java.lang.String	getFormattedBasketTotal() Returns the total price of the basket as a formatted string so that it may be used directly in the UI.
int	getNumberOfItems()
com.konakart.appif.StockReservationOptionsIf	getStockReservationOptions() Creates a StockReservationOptions object based on the current FetchProductOptions stored in the AppEng.
void	removeFromBasket(com.konakart.appif.BasketIf item, boolean refresh) The Basket object is removed from the database and so no longer appears in the customer's basket.
com.konakart.appif.BasketIf[]	reserveStock(com.konakart.appif.BasketIf[] basketItems) Before calling the engine we save any attached products and re-attach them on the returned basket items
void	setBasketTotal(java.math.BigDecimal basketTotal)
void	updateBasket(com.konakart.appif.BasketIf item, boolean refresh) Updates the Basket object in the database.
com.konakart.appif.BasketIf[]	updateBasketWithStockInfo(com.konakart.appif.BasketIf[] basketItems) Before calling the engine we save any attached products and re-attach them on the returned basket items

Methods inherited from class com.konakart.al.BaseMgr

getEng, getKkAppEng, getPages, isMgrReady, setEng, setKkAppEng

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasketMgr

protected BasketMgr(com.konakart.appif.KKEngIf eng,
                    KKAppEng kkAppEng)
             throws com.konakart.app.KKException

Constructor

Parameters:

eng - the eng

kkAppEng - the kkAppEng

Throws:

com.konakart.app.KKException - an unexpected KKException exception

Method Detail

getBasketItemsPerCustomer

public void getBasketItemsPerCustomer()
                               throws com.konakart.app.KKException,
                                      KKAppException

Get the basket items for a customer and language and set them on the customer customer object of the customerMgr. Each item has a fully populated product object.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

emptyBasket

public void emptyBasket()
                 throws com.konakart.app.KKException,
                        KKAppException

All items in the basket are removed from the database and the array of basket items for the current customer, are deleted.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

removeFromBasket

public void removeFromBasket(com.konakart.appif.BasketIf item,
                             boolean refresh)
                      throws com.konakart.app.KKException,
                             KKAppException

The Basket object is removed from the database and so no longer appears in the customer's basket. We read a new list from the database and refresh the current customer's basket if refresh is set to true.

Parameters:

item - The basket object to be removed

refresh - If set to true, the current customer's basket is refreshed

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

addToBasket

public void addToBasket(com.konakart.appif.BasketIf item,
                        boolean refresh)
                 throws com.konakart.app.KKException,
                        KKAppException

Saves a new Basket object in the database for the current customer. We read a new list from the database and refresh the current customer's basket if refresh is set to true.

Parameters:

item - The basket object to be added

refresh - If set to true, the current customer's basket is refreshed

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

addToBasketWithOptions

public void addToBasketWithOptions(com.konakart.appif.BasketIf item,
                                   com.konakart.appif.AddToBasketOptionsIf options,
                                   boolean refresh)
                            throws com.konakart.app.KKException,
                                   KKAppException

Saves a new Basket object in the database for the current customer. We read a new list from the database and refresh the current customer's basket if refresh is set to true. It receives an options object as input in order to configure certain aspects of the method.

Parameters:

item - The basket object to be added

options - An object containing options for the method. It may be set to null.

refresh - If set to true, the current customer's basket is refreshed

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

updateBasket

public void updateBasket(com.konakart.appif.BasketIf item,
                         boolean refresh)
                  throws com.konakart.app.KKException,
                         KKAppException

Updates the Basket object in the database. The only attribute that may be changed is quantity. We read a new list from the database and refresh the current customer's basket if refresh is set to true.

Parameters:

item - The basket object to be updated

refresh - If set to true, the current customer's basket is refreshed

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

getFormattedBasketTotal

public java.lang.String getFormattedBasketTotal()
                                         throws com.konakart.app.KKException,
                                                KKAppException

Returns the total price of the basket as a formatted string so that it may be used directly in the UI.

Returns:

Total value of basket already formatted

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

getBasketTotal

public java.math.BigDecimal getBasketTotal()
                                    throws com.konakart.app.KKException,
                                           KKAppException

Returns the total price of the basket as a BigDecimalValue

Returns:

Total value of basket already formatted

Throws:

com.konakart.app.KKException - an unexpected KKException exception

KKAppException - an unexpected KKAppException exception

getAddToBasketOptions

public com.konakart.appif.AddToBasketOptionsIf getAddToBasketOptions()

Creates an AddToBasketOptionsIf based on the current FetchProductOptions stored in the AppEng.

Returns:

Returns an AddToBasketOptionsIf object

getStockReservationOptions

public com.konakart.appif.StockReservationOptionsIf getStockReservationOptions()

Creates a StockReservationOptions object based on the current FetchProductOptions stored in the AppEng.

Returns:

Returns a StockReservationOptionsIf object

getNumberOfItems

public int getNumberOfItems()

Returns:

Returns the number of items in the basket

updateBasketWithStockInfo

public com.konakart.appif.BasketIf[] updateBasketWithStockInfo(com.konakart.appif.BasketIf[] basketItems)
                                                        throws com.konakart.app.KKException

Before calling the engine we save any attached products and re-attach them on the returned basket items

Parameters:

basketItems - the basketItems

Returns:

Returns an array of basket items

Throws:

com.konakart.app.KKException - an unexpected KKException exception

reserveStock

public com.konakart.appif.BasketIf[] reserveStock(com.konakart.appif.BasketIf[] basketItems)
                                           throws com.konakart.app.KKException

Before calling the engine we save any attached products and re-attach them on the returned basket items

Parameters:

basketItems - the basketItems

Returns:

Returns an array of basket items

Throws:

com.konakart.app.KKException - an unexpected KKException exception

setBasketTotal

public void setBasketTotal(java.math.BigDecimal basketTotal)

Parameters:

basketTotal - the basketTotal to set