com.konakart.app

Class AddToBasketOptions

java.lang.Object

com.konakart.app.AddToBasketOptions

All Implemented Interfaces:

AddToBasketOptionsIf

public class AddToBasketOptions
extends java.lang.Object
implements AddToBasketOptionsIf

An object used to contain options used when adding items to the basket.

Constructor Summary

Constructors

Constructor and Description
AddToBasketOptions() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogId() The id of the catalog which contains dynamic product information such as the price and quantity
java.util.Calendar	getPriceDate() The date for which a price is requested.
boolean	isAllowMultipleEntriesForSameProduct() Normally when an identical product is added to the basket more than once, rather than creating multiple basket entries we update the existing entry with an updated quantity.
boolean	isCalcQuantityForBundles() When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.
boolean	isCalculateOptionTax() When getBasketItemsPerCustomerWithOptions() is called, the price (including and excluding tax) of each basket item is returned.
boolean	isGetImages() When getting basket items we attach a product object to each basket item.
boolean	isGetStockReservationInfo() If true, information about reserved stock is returned by the method updateBasketWithStockInfoWithOptions()
boolean	isRemoveExpiredReservations() If true, in the updateBasketWithStockInfoWithOptions() method, when a reservation is detected to be expired, the reservation information of the returned basket item is removed and the reservation itself is deleted.
boolean	isUseExternalPrice() If true we attempt to fetch the prices from the external table
boolean	isUseExternalQuantity() If true we attempt to fetch the quantities from the external table
void	setAllowMultipleEntriesForSameProduct(boolean allowMultipleEntriesForSameProduct) Normally when an identical product is added to the basket more than once, rather than creating multiple basket entries we update the existing entry with an updated quantity.
void	setCalcQuantityForBundles(boolean calcQuantityForBundles) When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.
void	setCalculateOptionTax(boolean calculateOptionTax) When getBasketItemsPerCustomerWithOptions() is called, the price (including and excluding tax) of each basket item is returned.
void	setCatalogId(java.lang.String catalogId) The id of the catalog which contains dynamic product information such as the price and quantity
void	setGetImages(boolean getImages) When getting basket items we attach a product object to each basket item.
void	setGetStockReservationInfo(boolean getStockReservationInfo) If true, information about reserved stock is returned by the method updateBasketWithStockInfoWithOptions()
void	setPriceDate(java.util.Calendar priceDate) The date for which a price is requested.
void	setRemoveExpiredReservations(boolean removeExpiredReservations) If true, in the updateBasketWithStockInfoWithOptions() method, when a reservation is detected to be expired, the reservation information of the returned basket item is removed and the reservation itself is deleted.
void	setUseExternalPrice(boolean useExternalPrice) If true we attempt to fetch the prices from the external table
void	setUseExternalQuantity(boolean useExternalQuantity) If true we attempt to fetch the quantities from the external table

Methods inherited from class java.lang.Object

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

Constructor Detail

AddToBasketOptions

public AddToBasketOptions()

Constructor

Method Detail

isAllowMultipleEntriesForSameProduct

public boolean isAllowMultipleEntriesForSameProduct()

Description copied from interface: AddToBasketOptionsIf

Normally when an identical product is added to the basket more than once, rather than creating multiple basket entries we update the existing entry with an updated quantity. When this boolean is set, allow multiple entries of the same item.

Specified by:

isAllowMultipleEntriesForSameProduct in interface AddToBasketOptionsIf

Returns:

Returns the allowMultipleEntriesForSameProduct.

setAllowMultipleEntriesForSameProduct

public void setAllowMultipleEntriesForSameProduct(boolean allowMultipleEntriesForSameProduct)

Description copied from interface: AddToBasketOptionsIf

Normally when an identical product is added to the basket more than once, rather than creating multiple basket entries we update the existing entry with an updated quantity. When this boolean is set, allow multiple entries of the same item.

Specified by:

setAllowMultipleEntriesForSameProduct in interface AddToBasketOptionsIf

Parameters:

allowMultipleEntriesForSameProduct - The allowMultipleEntriesForSameProduct to set.

getCatalogId

public java.lang.String getCatalogId()

Description copied from interface: AddToBasketOptionsIf

The id of the catalog which contains dynamic product information such as the price and quantity

Specified by:

getCatalogId in interface AddToBasketOptionsIf

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Description copied from interface: AddToBasketOptionsIf

The id of the catalog which contains dynamic product information such as the price and quantity

Specified by:

setCatalogId in interface AddToBasketOptionsIf

Parameters:

catalogId - the catalogId to set

getPriceDate

public java.util.Calendar getPriceDate()

Description copied from interface: AddToBasketOptionsIf

The date for which a price is requested. It could be out in the future.

Specified by:

getPriceDate in interface AddToBasketOptionsIf

Returns:

the priceDate

setPriceDate

public void setPriceDate(java.util.Calendar priceDate)

Description copied from interface: AddToBasketOptionsIf

The date for which a price is requested. It could be out in the future.

Specified by:

setPriceDate in interface AddToBasketOptionsIf

Parameters:

priceDate - the priceDate to set

isUseExternalPrice

public boolean isUseExternalPrice()

Description copied from interface: AddToBasketOptionsIf

If true we attempt to fetch the prices from the external table

Specified by:

isUseExternalPrice in interface AddToBasketOptionsIf

Returns:

the useExternalPrice

setUseExternalPrice

public void setUseExternalPrice(boolean useExternalPrice)

Description copied from interface: AddToBasketOptionsIf

If true we attempt to fetch the prices from the external table

Specified by:

setUseExternalPrice in interface AddToBasketOptionsIf

Parameters:

useExternalPrice - the useExternalPrice to set

isUseExternalQuantity

public boolean isUseExternalQuantity()

Description copied from interface: AddToBasketOptionsIf

If true we attempt to fetch the quantities from the external table

Specified by:

isUseExternalQuantity in interface AddToBasketOptionsIf

Returns:

the useExternalQuantity

setUseExternalQuantity

public void setUseExternalQuantity(boolean useExternalQuantity)

Description copied from interface: AddToBasketOptionsIf

If true we attempt to fetch the quantities from the external table

Specified by:

setUseExternalQuantity in interface AddToBasketOptionsIf

Parameters:

useExternalQuantity - the useExternalQuantity to set

isCalcQuantityForBundles

public boolean isCalcQuantityForBundles()

Description copied from interface: AddToBasketOptionsIf

When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.

Specified by:

isCalcQuantityForBundles in interface AddToBasketOptionsIf

Returns:

the calcQuantityForBundles

setCalcQuantityForBundles

public void setCalcQuantityForBundles(boolean calcQuantityForBundles)

Description copied from interface: AddToBasketOptionsIf

When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.

Specified by:

setCalcQuantityForBundles in interface AddToBasketOptionsIf

Parameters:

calcQuantityForBundles - the calcQuantityForBundles to set

isGetImages

public boolean isGetImages()

When getting basket items we attach a product object to each basket item. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

isGetImages in interface AddToBasketOptionsIf

Returns:

the getImages

setGetImages

public void setGetImages(boolean getImages)

When getting basket items we attach a product object to each basket item. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

setGetImages in interface AddToBasketOptionsIf

Parameters:

getImages - the getImages to set

isGetStockReservationInfo

public boolean isGetStockReservationInfo()

If true, information about reserved stock is returned by the method updateBasketWithStockInfoWithOptions()

Specified by:

isGetStockReservationInfo in interface AddToBasketOptionsIf

Returns:

the getStockReservationInfo

setGetStockReservationInfo

public void setGetStockReservationInfo(boolean getStockReservationInfo)

If true, information about reserved stock is returned by the method updateBasketWithStockInfoWithOptions()

Specified by:

setGetStockReservationInfo in interface AddToBasketOptionsIf

Parameters:

getStockReservationInfo - the getStockReservationInfo to set

isRemoveExpiredReservations

public boolean isRemoveExpiredReservations()

If true, in the updateBasketWithStockInfoWithOptions() method, when a reservation is detected to be expired, the reservation information of the returned basket item is removed and the reservation itself is deleted. This attribute is only used when getStockReservationInfo is set to true. The default value is true.

Specified by:

isRemoveExpiredReservations in interface AddToBasketOptionsIf

Returns:

the removeExpiredReservations

setRemoveExpiredReservations

public void setRemoveExpiredReservations(boolean removeExpiredReservations)

If true, in the updateBasketWithStockInfoWithOptions() method, when a reservation is detected to be expired, the reservation information of the returned basket item is removed and the reservation itself is deleted. This attribute is only used when getStockReservationInfo is set to true. The default value is true.

Specified by:

setRemoveExpiredReservations in interface AddToBasketOptionsIf

Parameters:

removeExpiredReservations - the removeExpiredReservations to set

isCalculateOptionTax

public boolean isCalculateOptionTax()

When getBasketItemsPerCustomerWithOptions() is called, the price (including and excluding tax) of each basket item is returned. However, if the basket item has options, the option price including tax is not returned by default because in most cases it's never used and so it's not calculated. If calculateOptionTax() is set to true then the prices including tax for each option are calculated and returned.

Specified by:

isCalculateOptionTax in interface AddToBasketOptionsIf

Returns:

the calculateOptionTax

setCalculateOptionTax

public void setCalculateOptionTax(boolean calculateOptionTax)

When getBasketItemsPerCustomerWithOptions() is called, the price (including and excluding tax) of each basket item is returned. However, if the basket item has options, the option price including tax is not returned by default because in most cases it's never used and so it's not calculated. If calculateOptionTax() is set to true then the prices including tax for each option are calculated and returned.

Specified by:

setCalculateOptionTax in interface AddToBasketOptionsIf

Parameters:

calculateOptionTax - the calculateOptionTax to set