com.konakart.appif

Interface AddToBasketOptionsIf

All Known Implementing Classes:

AddToBasketOptions

public interface AddToBasketOptionsIf

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

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, the basket reserved stock attributes (reservationId, qtyResrvdForResId, reservationExpiryDate, reservationStartDate) are populated by the method updateBasketWithStockInfoWithOptions() and when retrieving basket items.
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, the basket reserved stock attributes (reservationId, qtyResrvdForResId, reservationExpiryDate, reservationStartDate) are populated by the method updateBasketWithStockInfoWithOptions() and when retrieving basket items.
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

Method Detail

isAllowMultipleEntriesForSameProduct

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. When this boolean is set, allow multiple entries of the same item.

Returns:

Returns the allowMultipleEntriesForSameProduct.

setAllowMultipleEntriesForSameProduct

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. When this boolean is set, allow multiple entries of the same item.

Parameters:

allowMultipleEntriesForSameProduct - The allowMultipleEntriesForSameProduct to set.

getCatalogId

java.lang.String getCatalogId()

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

Returns:

the catalogId

setCatalogId

void setCatalogId(java.lang.String catalogId)

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

Parameters:

catalogId - the catalogId to set

getPriceDate

java.util.Calendar getPriceDate()

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

Returns:

the priceDate

setPriceDate

void setPriceDate(java.util.Calendar priceDate)

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

Parameters:

priceDate - the priceDate to set

isUseExternalPrice

boolean isUseExternalPrice()

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

Returns:

the useExternalPrice

setUseExternalPrice

void setUseExternalPrice(boolean useExternalPrice)

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

Parameters:

useExternalPrice - the useExternalPrice to set

isUseExternalQuantity

boolean isUseExternalQuantity()

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

Returns:

the useExternalQuantity

setUseExternalQuantity

void setUseExternalQuantity(boolean useExternalQuantity)

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

Parameters:

useExternalQuantity - the useExternalQuantity to set

isCalcQuantityForBundles

boolean isCalcQuantityForBundles()

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

Returns:

the calcQuantityForBundles

setCalcQuantityForBundles

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.

Parameters:

calcQuantityForBundles - the calcQuantityForBundles to set

isGetImages

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.

Returns:

the getImages

setGetImages

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.

Parameters:

getImages - the getImages to set

isGetStockReservationInfo

boolean isGetStockReservationInfo()

If true, the basket reserved stock attributes (reservationId, qtyResrvdForResId, reservationExpiryDate, reservationStartDate) are populated by the method updateBasketWithStockInfoWithOptions() and when retrieving basket items. The attribute quantityReserved is also populated by updateBasketWithStockInfoWithOptions().

Returns:

the getStockReservationInfo

setGetStockReservationInfo

void setGetStockReservationInfo(boolean getStockReservationInfo)

If true, the basket reserved stock attributes (reservationId, qtyResrvdForResId, reservationExpiryDate, reservationStartDate) are populated by the method updateBasketWithStockInfoWithOptions() and when retrieving basket items. The attribute quantityReserved is also populated by updateBasketWithStockInfoWithOptions().

Parameters:

getStockReservationInfo - the getStockReservationInfo to set

isRemoveExpiredReservations

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.

Returns:

the removeExpiredReservations

setRemoveExpiredReservations

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.

Parameters:

removeExpiredReservations - the removeExpiredReservations to set

isCalculateOptionTax

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.

Returns:

the calculateOptionTax

setCalculateOptionTax

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.

Parameters:

calculateOptionTax - the calculateOptionTax to set