com.konakart.appif

Interface BasketIf

All Known Implementing Classes:

Basket

public interface BasketIf

One basket object corresponds to an item in the shopping cart.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustom1()
java.lang.String	getCustom10()
java.lang.String	getCustom11()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.lang.String	getCustom6()
java.lang.String	getCustom7()
java.lang.String	getCustom8()
java.lang.String	getCustom9()
int	getCustomerId()
java.util.Calendar	getDateAdded()
java.util.Calendar	getDateAvailable() The date when the product will become available
java.lang.String	getEncodedProduct() The encodedProduct is in the form 1{3}5{4}1 where the first number is the product id.
java.math.BigDecimal	getFinalPriceExTax() This is the price without including tax.
java.math.BigDecimal	getFinalPriceIncTax() This is the price including tax.
int	getId()
OptionIf[]	getOpts() An array of Option objects that further defines the product.
ProductIf	getProduct()
int	getProductId()
int	getQtyResrvdForResId() When a reservation id is present, this attribute defines the number of products that have been reserved connected with this reservationId.
int	getQuantity()
int	getQuantityInStock()
int	getQuantityReserved() This attribute defines the total number of products that are currently reserved.
java.util.Calendar	getReservationExpiryDate() The time when the stock reservation defined by the reservationId, expires.
int	getReservationId() Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.
java.util.Calendar	getReservationStartDate() The start time for the stock reservation defined by the reservationId.
java.lang.String	getSku() The SKU of the product
int	getWishListId() Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.
int	getWishListItemId() Set to the id of the wish list item (gift registry item) to keep track that it has been added from a gift registry and which item it corresponds to.
boolean	isUseBasketPrice() When set, the price of the basket object is used rather than getting the price from the product object.
void	setCustom1(java.lang.String custom1)
void	setCustom10(java.lang.String custom10)
void	setCustom11(java.lang.String custom11)
void	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
void	setCustom6(java.lang.String custom6)
void	setCustom7(java.lang.String custom7)
void	setCustom8(java.lang.String custom8)
void	setCustom9(java.lang.String custom9)
void	setCustomerId(int customerId)
void	setDateAdded(java.util.Calendar dateAdded)
void	setDateAvailable(java.util.Calendar dateAvailable) The date when the product will become available
void	setEncodedProduct(java.lang.String encodedProduct) The encodedProduct is in the form 1{3}5{4}1 where the first number is the product id.
void	setFinalPriceExTax(java.math.BigDecimal finalPriceExTax) This is the price without including tax.
void	setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax) This is the price including tax.
void	setId(int id)
void	setOpts(OptionIf[] opts) An array of Option objects that further defines the product.
void	setProduct(ProductIf product)
void	setProductId(int productId)
void	setQtyResrvdForResId(int qtyResrvdForResId) When a reservation id is present, this attribute defines the number of products that have been reserved connected with this reservationId.
void	setQuantity(int quantity)
void	setQuantityInStock(int quantityInStock)
void	setQuantityReserved(int quantityReserved) This attribute defines the total number of products that are currently reserved.
void	setReservationExpiryDate(java.util.Calendar reservationExpiryDate) The time when the stock reservation defined by the reservationId, expires.
void	setReservationId(int reservationId) Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.
void	setReservationStartDate(java.util.Calendar reservationStartDate) The start time for the stock reservation defined by the reservationId.
void	setSku(java.lang.String sku) The SKU of the product
void	setUseBasketPrice(boolean useBasketPrice) When set, the price of the basket object is used rather than getting the price from the product object.
void	setWishListId(int wishListId) Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.
void	setWishListItemId(int wishListItemId) Set to the id of the wish list item (gift registry item) to keep track that it has been added from a gift registry and which item it corresponds to.

Method Detail

getDateAdded

java.util.Calendar getDateAdded()

Returns:

Returns the dateAdded.

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - The dateAdded to set.

getEncodedProduct

java.lang.String getEncodedProduct()

The encodedProduct is in the form 1{3}5{4}1 where the first number is the product id. The number pairs following the first number define the {OptionId}OptionValueId . For example this could be Model Type = Premium or Memory size = 1GB etc. If the basket has an encoded product, then it should have an array of Options that match the encoded product.

Returns:

Returns the encodedProduct.

setEncodedProduct

void setEncodedProduct(java.lang.String encodedProduct)

The encodedProduct is in the form 1{3}5{4}1 where the first number is the product id. The number pairs following the first number define the {OptionId}OptionValueId . For example this could be Model Type = Premium or Memory size = 1GB etc. If the basket has an encoded product, then it should have an array of Options that match the encoded product.

Parameters:

encodedProduct - The encodedProduct to set.

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getOpts

OptionIf[] getOpts()

An array of Option objects that further defines the product. i.e. Size = small, color = blue. The encodedProductId should match this array of options.

Returns:

Returns the opts.

setOpts

void setOpts(OptionIf[] opts)

An array of Option objects that further defines the product. i.e. Size = small, color = blue. The encodedProductId should match this array of options.

Parameters:

opts - The opts to set.

getProduct

ProductIf getProduct()

Returns:

Returns the product.

setProduct

void setProduct(ProductIf product)

Parameters:

product - The product to set.

getProductId

int getProductId()

Returns:

Returns the productId.

setProductId

void setProductId(int productId)

Parameters:

productId - The productId to set.

getQuantity

int getQuantity()

Returns:

Returns the quantity.

setQuantity

void setQuantity(int quantity)

Parameters:

quantity - The quantity to set.

getFinalPriceExTax

java.math.BigDecimal getFinalPriceExTax()

This is the price without including tax.

Returns:

Returns the finalPriceExTax.

setFinalPriceExTax

void setFinalPriceExTax(java.math.BigDecimal finalPriceExTax)

This is the price without including tax.

Parameters:

finalPriceExTax - The finalPriceExTax to set.

getFinalPriceIncTax

java.math.BigDecimal getFinalPriceIncTax()

This is the price including tax.

Returns:

Returns the finalPriceIncTax.

setFinalPriceIncTax

void setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax)

This is the price including tax.

Parameters:

finalPriceIncTax - The finalPriceIncTax to set.

getQuantityInStock

int getQuantityInStock()

Returns:

Returns the quantityInStock.

setQuantityInStock

void setQuantityInStock(int quantityInStock)

Parameters:

quantityInStock - The quantityInStock to set.

getDateAvailable

java.util.Calendar getDateAvailable()

The date when the product will become available

Returns:

the dateAvailable

setDateAvailable

void setDateAvailable(java.util.Calendar dateAvailable)

The date when the product will become available

Parameters:

dateAvailable - the dateAvailable to set

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.

getCustom6

java.lang.String getCustom6()

Returns:

the custom6

setCustom6

void setCustom6(java.lang.String custom6)

Parameters:

custom6 - the custom6 to set

getCustom7

java.lang.String getCustom7()

Returns:

the custom7

setCustom7

void setCustom7(java.lang.String custom7)

Parameters:

custom7 - the custom7 to set

getCustom8

java.lang.String getCustom8()

Returns:

the custom8

setCustom8

void setCustom8(java.lang.String custom8)

Parameters:

custom8 - the custom8 to set

getCustom9

java.lang.String getCustom9()

Returns:

the custom9

setCustom9

void setCustom9(java.lang.String custom9)

Parameters:

custom9 - the custom9 to set

getCustom10

java.lang.String getCustom10()

Returns:

the custom10

setCustom10

void setCustom10(java.lang.String custom10)

Parameters:

custom10 - the custom10 to set

getCustom11

java.lang.String getCustom11()

Returns:

the custom11

setCustom11

void setCustom11(java.lang.String custom11)

Parameters:

custom11 - the custom11 to set

getSku

java.lang.String getSku()

The SKU of the product

Returns:

the sku

setSku

void setSku(java.lang.String sku)

The SKU of the product

Parameters:

sku - the sku to set

getWishListId

int getWishListId()

Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.

Returns:

the wishListId

setWishListId

void setWishListId(int wishListId)

Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.

Parameters:

wishListId - the wishListId to set

getWishListItemId

int getWishListItemId()

Set to the id of the wish list item (gift registry item) to keep track that it has been added from a gift registry and which item it corresponds to.

Returns:

the wishListItemId

setWishListItemId

void setWishListItemId(int wishListItemId)

Set to the id of the wish list item (gift registry item) to keep track that it has been added from a gift registry and which item it corresponds to.

Parameters:

wishListItemId - the wishListItemId to set

isUseBasketPrice

boolean isUseBasketPrice()

When set, the price of the basket object is used rather than getting the price from the product object.

Returns:

the useBasketPrice

setUseBasketPrice

void setUseBasketPrice(boolean useBasketPrice)

When set, the price of the basket object is used rather than getting the price from the product object.

Parameters:

useBasketPrice - the useBasketPrice to set

getReservationId

int getReservationId()

Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.

Returns:

the reservationId

setReservationId

void setReservationId(int reservationId)

Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.

Parameters:

reservationId - the reservationId to set

getQtyResrvdForResId

int getQtyResrvdForResId()

When a reservation id is present, this attribute defines the number of products that have been reserved connected with this reservationId. It may not always match the number of products ordered.

Returns:

the qtyResrvdForResId

setQtyResrvdForResId

void setQtyResrvdForResId(int qtyResrvdForResId)

When a reservation id is present, this attribute defines the number of products that have been reserved connected with this reservationId. It may not always match the number of products ordered.

Parameters:

qtyResrvdForResId - the qtyResrvdForResId to set

getQuantityReserved

int getQuantityReserved()

This attribute defines the total number of products that are currently reserved.

Returns:

the quantityReserved

setQuantityReserved

void setQuantityReserved(int quantityReserved)

This attribute defines the total number of products that are currently reserved.

Parameters:

quantityReserved - the quantityReserved to set

getReservationExpiryDate

java.util.Calendar getReservationExpiryDate()

The time when the stock reservation defined by the reservationId, expires.

Returns:

the reservationExpiryDate

setReservationExpiryDate

void setReservationExpiryDate(java.util.Calendar reservationExpiryDate)

The time when the stock reservation defined by the reservationId, expires.

Parameters:

reservationExpiryDate - the reservationExpiryDate to set

getReservationStartDate

java.util.Calendar getReservationStartDate()

The start time for the stock reservation defined by the reservationId.

Returns:

the reservationStartDate

setReservationStartDate

void setReservationStartDate(java.util.Calendar reservationStartDate)

The start time for the stock reservation defined by the reservationId.

Parameters:

reservationStartDate - the reservationStartDate to set

getCustomerId

int getCustomerId()

Returns:

the customerId

setCustomerId

void setCustomerId(int customerId)

Parameters:

customerId - the customerId to set