Basket (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.Basket

All Implemented Interfaces:: BasketIf

public class Basket
extends java.lang.Object
implements BasketIf

Basket class

Constructor Summary

Constructors
Constructor and Description
`Basket()` Constructor
`Basket(com.workingdogs.village.Record vr, KKCriteria c)` Instantiates the attributes of the Basket object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`calculatePrice(int scale)` Calculate the price of the basket item
`java.math.BigDecimal`	`calculatePrice(int scale, boolean enhancedVariantHandling)` Calculate the price of the basket item
`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`	`getQuantityAvailable()`
`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`	`isReserved()` Method to determine whether a valid reservation exists
`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.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Basket
```
public Basket()
```
    Constructor
  - Basket
```
public Basket(com.workingdogs.village.Record vr,
              KKCriteria c)
       throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the Basket object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Basket object and those of its Options.
  - calculatePrice
```
public java.math.BigDecimal calculatePrice(int scale)
                                    throws com.konakart.app.KKException
```
    Calculate the price of the basket item
    
    Parameters:
    
    scale - the scale
    
    Returns:
    
    Return the total price of this basket item including the chosen options and any special price that may be available.
    
    Throws:
    
    KKException - an unexpected KKException exception
  - calculatePrice
```
public java.math.BigDecimal calculatePrice(int scale,
                                           boolean enhancedVariantHandling)
                                    throws com.konakart.app.KKException
```
    Calculate the price of the basket item
    
    Parameters:
    
    scale - the scale
    
    enhancedVariantHandling - true if MAGO like variant handling is active
    
    Returns:
    
    Return the total price of this basket item including the chosen options and any special price that may be available.
    
    Throws:
    
    KKException - an unexpected KKException exception
  - getDateAdded
```
public java.util.Calendar getDateAdded()
```
    Specified by:
    
    getDateAdded in interface BasketIf
    
    Returns:
    
    Returns the dateAdded.
  - setDateAdded
```
public void setDateAdded(java.util.Calendar dateAdded)
```
    Specified by:
    
    setDateAdded in interface BasketIf
    
    Parameters:
    
    dateAdded - The dateAdded to set.
  - getEncodedProduct
```
public java.lang.String getEncodedProduct()
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    getEncodedProduct in interface BasketIf
    
    Returns:
    
    Returns the encodedProduct.
  - setEncodedProduct
```
public void setEncodedProduct(java.lang.String encodedProduct)
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    setEncodedProduct in interface BasketIf
    
    Parameters:
    
    encodedProduct - The encodedProduct to set.
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface BasketIf
    
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Specified by:
    
    setId in interface BasketIf
    
    Parameters:
    
    id - The id to set.
  - getOpts
```
public OptionIf[] getOpts()
```
    Description copied from interface: BasketIf
    
    An array of Option objects that further defines the product. i.e. Size = small, color = blue. The encodedProductId should match this array of options.
    
    Specified by:
    
    getOpts in interface BasketIf
    
    Returns:
    
    Returns the opts.
  - setOpts
```
public void setOpts(OptionIf[] opts)
```
    Description copied from interface: BasketIf
    
    An array of Option objects that further defines the product. i.e. Size = small, color = blue. The encodedProductId should match this array of options.
    
    Specified by:
    
    setOpts in interface BasketIf
    
    Parameters:
    
    opts - The opts to set.
  - getProduct
```
public ProductIf getProduct()
```
    Specified by:
    
    getProduct in interface BasketIf
    
    Returns:
    
    Returns the product.
  - setProduct
```
public void setProduct(ProductIf product)
```
    Specified by:
    
    setProduct in interface BasketIf
    
    Parameters:
    
    product - The product to set.
  - getProductId
```
public int getProductId()
```
    Specified by:
    
    getProductId in interface BasketIf
    
    Returns:
    
    Returns the productId.
  - setProductId
```
public void setProductId(int productId)
```
    Specified by:
    
    setProductId in interface BasketIf
    
    Parameters:
    
    productId - The productId to set.
  - getQuantity
```
public int getQuantity()
```
    Specified by:
    
    getQuantity in interface BasketIf
    
    Returns:
    
    Returns the quantity.
  - setQuantity
```
public void setQuantity(int quantity)
```
    Specified by:
    
    setQuantity in interface BasketIf
    
    Parameters:
    
    quantity - The quantity to set.
  - getFinalPriceExTax
```
public java.math.BigDecimal getFinalPriceExTax()
```
    Description copied from interface: BasketIf
    
    This is the price without including tax.
    
    Specified by:
    
    getFinalPriceExTax in interface BasketIf
    
    Returns:
    
    Returns the finalPriceExTax.
  - setFinalPriceExTax
```
public void setFinalPriceExTax(java.math.BigDecimal finalPriceExTax)
```
    Description copied from interface: BasketIf
    
    This is the price without including tax.
    
    Specified by:
    
    setFinalPriceExTax in interface BasketIf
    
    Parameters:
    
    finalPriceExTax - The finalPriceExTax to set.
  - getFinalPriceIncTax
```
public java.math.BigDecimal getFinalPriceIncTax()
```
    Description copied from interface: BasketIf
    
    This is the price including tax.
    
    Specified by:
    
    getFinalPriceIncTax in interface BasketIf
    
    Returns:
    
    Returns the finalPriceIncTax.
  - setFinalPriceIncTax
```
public void setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax)
```
    Description copied from interface: BasketIf
    
    This is the price including tax.
    
    Specified by:
    
    setFinalPriceIncTax in interface BasketIf
    
    Parameters:
    
    finalPriceIncTax - The finalPriceIncTax to set.
  - getQuantityInStock
```
public int getQuantityInStock()
```
    Specified by:
    
    getQuantityInStock in interface BasketIf
    
    Returns:
    
    Returns the quantityInStock.
  - setQuantityInStock
```
public void setQuantityInStock(int quantityInStock)
```
    Specified by:
    
    setQuantityInStock in interface BasketIf
    
    Parameters:
    
    quantityInStock - The quantityInStock to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface BasketIf
    
    Returns:
    
    Returns the custom1.
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface BasketIf
    
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface BasketIf
    
    Returns:
    
    Returns the custom2.
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface BasketIf
    
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
public java.lang.String getCustom3()
```
    Specified by:
    
    getCustom3 in interface BasketIf
    
    Returns:
    
    Returns the custom3.
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Specified by:
    
    setCustom3 in interface BasketIf
    
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
public java.lang.String getCustom4()
```
    Specified by:
    
    getCustom4 in interface BasketIf
    
    Returns:
    
    Returns the custom4.
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Specified by:
    
    setCustom4 in interface BasketIf
    
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
public java.lang.String getCustom5()
```
    Specified by:
    
    getCustom5 in interface BasketIf
    
    Returns:
    
    Returns the custom5.
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Specified by:
    
    setCustom5 in interface BasketIf
    
    Parameters:
    
    custom5 - The custom5 to set.
  - getCustom6
```
public java.lang.String getCustom6()
```
    Specified by:
    
    getCustom6 in interface BasketIf
    
    Returns:
    
    the custom6
  - setCustom6
```
public void setCustom6(java.lang.String custom6)
```
    Specified by:
    
    setCustom6 in interface BasketIf
    
    Parameters:
    
    custom6 - the custom6 to set
  - getCustom7
```
public java.lang.String getCustom7()
```
    Specified by:
    
    getCustom7 in interface BasketIf
    
    Returns:
    
    the custom7
  - setCustom7
```
public void setCustom7(java.lang.String custom7)
```
    Specified by:
    
    setCustom7 in interface BasketIf
    
    Parameters:
    
    custom7 - the custom7 to set
  - getCustom8
```
public java.lang.String getCustom8()
```
    Specified by:
    
    getCustom8 in interface BasketIf
    
    Returns:
    
    the custom8
  - setCustom8
```
public void setCustom8(java.lang.String custom8)
```
    Specified by:
    
    setCustom8 in interface BasketIf
    
    Parameters:
    
    custom8 - the custom8 to set
  - getCustom9
```
public java.lang.String getCustom9()
```
    Specified by:
    
    getCustom9 in interface BasketIf
    
    Returns:
    
    the custom9
  - setCustom9
```
public void setCustom9(java.lang.String custom9)
```
    Specified by:
    
    setCustom9 in interface BasketIf
    
    Parameters:
    
    custom9 - the custom9 to set
  - getCustom10
```
public java.lang.String getCustom10()
```
    Specified by:
    
    getCustom10 in interface BasketIf
    
    Returns:
    
    the custom10
  - setCustom10
```
public void setCustom10(java.lang.String custom10)
```
    Specified by:
    
    setCustom10 in interface BasketIf
    
    Parameters:
    
    custom10 - the custom10 to set
  - getCustom11
```
public java.lang.String getCustom11()
```
    Specified by:
    
    getCustom11 in interface BasketIf
    
    Returns:
    
    the custom11
  - setCustom11
```
public void setCustom11(java.lang.String custom11)
```
    Specified by:
    
    setCustom11 in interface BasketIf
    
    Parameters:
    
    custom11 - the custom11 to set
  - getDateAvailable
```
public java.util.Calendar getDateAvailable()
```
    Description copied from interface: BasketIf
    
    The date when the product will become available
    
    Specified by:
    
    getDateAvailable in interface BasketIf
    
    Returns:
    
    the dateAvailable
  - setDateAvailable
```
public void setDateAvailable(java.util.Calendar dateAvailable)
```
    Description copied from interface: BasketIf
    
    The date when the product will become available
    
    Specified by:
    
    setDateAvailable in interface BasketIf
    
    Parameters:
    
    dateAvailable - the dateAvailable to set
  - getSku
```
public java.lang.String getSku()
```
    Description copied from interface: BasketIf
    
    The SKU of the product
    
    Specified by:
    
    getSku in interface BasketIf
    
    Returns:
    
    the sku
  - setSku
```
public void setSku(java.lang.String sku)
```
    Description copied from interface: BasketIf
    
    The SKU of the product
    
    Specified by:
    
    setSku in interface BasketIf
    
    Parameters:
    
    sku - the sku to set
  - getWishListId
```
public int getWishListId()
```
    Description copied from interface: BasketIf
    
    Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.
    
    Specified by:
    
    getWishListId in interface BasketIf
    
    Returns:
    
    the wishListId
  - setWishListId
```
public void setWishListId(int wishListId)
```
    Description copied from interface: BasketIf
    
    Set to the id of the wish list (gift registry) to keep track that it has been added from a gift registry.
    
    Specified by:
    
    setWishListId in interface BasketIf
    
    Parameters:
    
    wishListId - the wishListId to set
  - getWishListItemId
```
public int getWishListItemId()
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    getWishListItemId in interface BasketIf
    
    Returns:
    
    the wishListItemId
  - setWishListItemId
```
public void setWishListItemId(int wishListItemId)
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    setWishListItemId in interface BasketIf
    
    Parameters:
    
    wishListItemId - the wishListItemId to set
  - isUseBasketPrice
```
public boolean isUseBasketPrice()
```
    Description copied from interface: BasketIf
    
    When set, the price of the basket object is used rather than getting the price from the product object.
    
    Specified by:
    
    isUseBasketPrice in interface BasketIf
    
    Returns:
    
    the useBasketPrice
  - setUseBasketPrice
```
public void setUseBasketPrice(boolean useBasketPrice)
```
    Description copied from interface: BasketIf
    
    When set, the price of the basket object is used rather than getting the price from the product object.
    
    Specified by:
    
    setUseBasketPrice in interface BasketIf
    
    Parameters:
    
    useBasketPrice - the useBasketPrice to set
  - getReservationId
```
public int getReservationId()
```
    Description copied from interface: BasketIf
    
    Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.
    
    Specified by:
    
    getReservationId in interface BasketIf
    
    Returns:
    
    the reservationId
  - setReservationId
```
public void setReservationId(int reservationId)
```
    Description copied from interface: BasketIf
    
    Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.
    
    Specified by:
    
    setReservationId in interface BasketIf
    
    Parameters:
    
    reservationId - the reservationId to set
  - getQtyResrvdForResId
```
public int getQtyResrvdForResId()
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    getQtyResrvdForResId in interface BasketIf
    
    Returns:
    
    the qtyResrvdForResId
  - setQtyResrvdForResId
```
public void setQtyResrvdForResId(int qtyResrvdForResId)
```
    Description copied from interface: BasketIf
    
    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.
    
    Specified by:
    
    setQtyResrvdForResId in interface BasketIf
    
    Parameters:
    
    qtyResrvdForResId - the qtyResrvdForResId to set
  - getQuantityReserved
```
public int getQuantityReserved()
```
    Description copied from interface: BasketIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    getQuantityReserved in interface BasketIf
    
    Returns:
    
    the quantityReserved
  - setQuantityReserved
```
public void setQuantityReserved(int quantityReserved)
```
    Description copied from interface: BasketIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    setQuantityReserved in interface BasketIf
    
    Parameters:
    
    quantityReserved - the quantityReserved to set
  - getQuantityAvailable
```
public int getQuantityAvailable()
```
    Returns:
    
    the quantityAvailable
  - getReservationExpiryDate
```
public java.util.Calendar getReservationExpiryDate()
```
    Description copied from interface: BasketIf
    
    The time when the stock reservation defined by the reservationId, expires.
    
    Specified by:
    
    getReservationExpiryDate in interface BasketIf
    
    Returns:
    
    the reservationExpiryDate
  - setReservationExpiryDate
```
public void setReservationExpiryDate(java.util.Calendar reservationExpiryDate)
```
    Description copied from interface: BasketIf
    
    The time when the stock reservation defined by the reservationId, expires.
    
    Specified by:
    
    setReservationExpiryDate in interface BasketIf
    
    Parameters:
    
    reservationExpiryDate - the reservationExpiryDate to set
  - isReserved
```
public boolean isReserved()
```
    Method to determine whether a valid reservation exists
    
    Returns:
    
    Returns true if getQtyResrvdForResId() > 0 and the reservation hasn't expired and the reservationId > 0
  - getCustomerId
```
public int getCustomerId()
```
    Specified by:
    
    getCustomerId in interface BasketIf
    
    Returns:
    
    the customerId
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Specified by:
    
    setCustomerId in interface BasketIf
    
    Parameters:
    
    customerId - the customerId to set
  - getReservationStartDate
```
public java.util.Calendar getReservationStartDate()
```
    Description copied from interface: BasketIf
    
    The start time for the stock reservation defined by the reservationId.
    
    Specified by:
    
    getReservationStartDate in interface BasketIf
    
    Returns:
    
    the reservationStartDate
  - setReservationStartDate
```
public void setReservationStartDate(java.util.Calendar reservationStartDate)
```
    Description copied from interface: BasketIf
    
    The start time for the stock reservation defined by the reservationId.
    
    Specified by:
    
    setReservationStartDate in interface BasketIf
    
    Parameters:
    
    reservationStartDate - the reservationStartDate to set

Class Basket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Basket

Basket

Method Detail

toString

calculatePrice

calculatePrice

getDateAdded

setDateAdded

getEncodedProduct

setEncodedProduct

getId

setId

getOpts

setOpts

getProduct

setProduct

getProductId

setProductId

getQuantity

setQuantity

getFinalPriceExTax

setFinalPriceExTax

getFinalPriceIncTax

setFinalPriceIncTax

getQuantityInStock

setQuantityInStock

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCustom6

setCustom6

getCustom7

setCustom7

getCustom8

setCustom8

getCustom9

setCustom9

getCustom10

setCustom10

getCustom11

setCustom11

getDateAvailable

setDateAvailable

getSku

setSku

getWishListId

setWishListId

getWishListItemId

setWishListItemId

isUseBasketPrice

setUseBasketPrice

getReservationId

setReservationId

getQtyResrvdForResId

setQtyResrvdForResId

getQuantityReserved

setQuantityReserved

getQuantityAvailable

getReservationExpiryDate

setReservationExpiryDate

isReserved

getCustomerId

setCustomerId

getReservationStartDate

setReservationStartDate