OrderProduct (KonaKart Server Engine API Documentation)

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

All Implemented Interfaces:: OrderProductIf

public class OrderProduct
extends java.lang.Object
implements OrderProductIf

OrderProduct class

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`calculateTotals(int scale, int taxQuantityRule)` We calculate finalPriceIncTax, finalPriceExTax and tax starting from price which is the price of one product without options and without tax.
`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()`
`ProdCustAttrIf[]`	`getCustomAttrArray()` The array form of the Custom Attributes
`java.lang.String`	`getCustomAttrs()` The XML form of the Custom Attributes
`java.math.BigDecimal`	`getDiscountPercent()` Used mainly with percentage tiered pricing discounts to store the percentage discount.
`java.math.BigDecimal`	`getFinalPriceExTax()`
`java.math.BigDecimal`	`getFinalPriceIncTax()`
`int`	`getId()`
`java.lang.String`	`getModel()` The product model.
`java.lang.String`	`getName()` The product name.
`OptionIf[]`	`getOpts()` An array of Option objects defining how the details of the product.
`OrderIf`	`getOrder()`
`int`	`getOrderId()`
`java.math.BigDecimal`	`getPrice()` The price of a single product without tax or options.
`java.math.BigDecimal`	`getPrice0()`
`java.math.BigDecimal`	`getPrice1()`
`java.math.BigDecimal`	`getPrice2()`
`java.math.BigDecimal`	`getPrice3()`
`java.math.BigDecimal`	`getPricePerUnit()`
`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`	`getRefundPoints()` The number of points allocated for a single product.
`java.math.BigDecimal`	`getRefundValue()` The final unit price of a product having taken into account all discounts.
`int`	`getReservationId()` Used when products are reserved during checkout to allow a customer to checkout without risking the product going out of stock.
`java.lang.String`	`getSku()` The SKU of the product
`int`	`getState()` The state of the product when added to the order.
`java.math.BigDecimal`	`getTax()` The amount of tax added.
`java.lang.String`	`getTaxCode()` tax code used when looking up tax from an external service
`java.math.BigDecimal`	`getTaxRate()` The tax rate applied.
`java.lang.String`	`getTaxRateCode()` The code of the tax rate
`int`	`getType()` product type.
`java.math.BigDecimal`	`getWeight()` The weight 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.
`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`	`setCustomAttrArray(ProdCustAttrIf[] customAttrArray)` Set the array form of the Custom Attributes
`void`	`setCustomAttrs(java.lang.String customAttrs)` Set the XML form of the Custom Attributes
`void`	`setDiscountPercent(java.math.BigDecimal discountPercent)` Used mainly with percentage tiered pricing discounts to store the percentage discount.
`void`	`setFinalPriceExTax(java.math.BigDecimal finalPriceExTax)`
`void`	`setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax)`
`void`	`setId(int id)`
`void`	`setModel(java.lang.String model)` The product model.
`void`	`setName(java.lang.String name)` The product name.
`void`	`setOpts(OptionIf[] opts)` An array of Option objects defining how the details of the product.
`void`	`setOrder(OrderIf order)`
`void`	`setOrderId(int orderId)`
`void`	`setPrice(java.math.BigDecimal price)` The price of a single product without tax or options.
`void`	`setPrice0(java.math.BigDecimal price0)`
`void`	`setPrice1(java.math.BigDecimal price1)`
`void`	`setPrice2(java.math.BigDecimal price2)`
`void`	`setPrice3(java.math.BigDecimal price3)`
`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`	`setRefundPoints(int refundPoints)` The number of points allocated for a single product.
`void`	`setRefundValue(java.math.BigDecimal refundValue)` The final unit price of a product having taken into account all discounts.
`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`	`setSku(java.lang.String sku)` The SKU of the product
`void`	`setState(int state)` The state of the product when added to the order.
`void`	`setTax(java.math.BigDecimal tax)` The amount of tax added.
`void`	`setTaxCode(java.lang.String taxCode)` tax code used when looking up tax from an external service
`void`	`setTaxRate(java.math.BigDecimal taxRate)` The tax rate applied.
`void`	`setTaxRateCode(java.lang.String taxRateCode)` The code of the tax rate
`void`	`setType(int type)` product type.
`void`	`setWeight(java.math.BigDecimal weight)` The weight of the product
`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
  - OrderProduct
```
public OrderProduct()
```
    Constructor
  - OrderProduct
```
public OrderProduct(com.workingdogs.village.Record vr,
                    KKCriteria c)
             throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the OrderProduct 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 OrderProduct object.
  - calculateTotals
```
public void calculateTotals(int scale,
                            int taxQuantityRule)
```
    We calculate finalPriceIncTax, finalPriceExTax and tax starting from price which is the price of one product without options and without tax. If discountPercent is not null, we apply a discount to the finalPriceExTax once we've calculated the final price by adding option values.
    
    Parameters:
    
    scale - The scale used in the calculations
    
    taxQuantityRule - The tax calculation rule to use
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface OrderProductIf
    
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Specified by:
    
    setId in interface OrderProductIf
    
    Parameters:
    
    id - The id to set.
  - getModel
```
public java.lang.String getModel()
```
    Description copied from interface: OrderProductIf
    
    The product model.
    
    Specified by:
    
    getModel in interface OrderProductIf
    
    Returns:
    
    Returns the model.
  - setModel
```
public void setModel(java.lang.String model)
```
    Description copied from interface: OrderProductIf
    
    The product model.
    
    Specified by:
    
    setModel in interface OrderProductIf
    
    Parameters:
    
    model - The model to set.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: OrderProductIf
    
    The product name.
    
    Specified by:
    
    getName in interface OrderProductIf
    
    Returns:
    
    Returns the name.
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: OrderProductIf
    
    The product name.
    
    Specified by:
    
    setName in interface OrderProductIf
    
    Parameters:
    
    name - The name to set.
  - getOpts
```
public OptionIf[] getOpts()
```
    Description copied from interface: OrderProductIf
    
    An array of Option objects defining how the details of the product. e.g. color, size, amount of memory etc.
    
    Specified by:
    
    getOpts in interface OrderProductIf
    
    Returns:
    
    Returns the opts.
  - setOpts
```
public void setOpts(OptionIf[] opts)
```
    Description copied from interface: OrderProductIf
    
    An array of Option objects defining how the details of the product. e.g. color, size, amount of memory etc.
    
    Specified by:
    
    setOpts in interface OrderProductIf
    
    Parameters:
    
    opts - The opts to set.
  - getOrder
```
public OrderIf getOrder()
```
    Specified by:
    
    getOrder in interface OrderProductIf
    
    Returns:
    
    Returns the order.
  - setOrder
```
public void setOrder(OrderIf order)
```
    Specified by:
    
    setOrder in interface OrderProductIf
    
    Parameters:
    
    order - The order to set.
  - getOrderId
```
public int getOrderId()
```
    Specified by:
    
    getOrderId in interface OrderProductIf
    
    Returns:
    
    Returns the orderId.
  - setOrderId
```
public void setOrderId(int orderId)
```
    Specified by:
    
    setOrderId in interface OrderProductIf
    
    Parameters:
    
    orderId - The orderId to set.
  - getPrice
```
public java.math.BigDecimal getPrice()
```
    Description copied from interface: OrderProductIf
    
    The price of a single product without tax or options.
    
    Specified by:
    
    getPrice in interface OrderProductIf
    
    Returns:
    
    Returns the price.
  - getPricePerUnit
```
public java.math.BigDecimal getPricePerUnit()
```
    Returns:
    
    Returns the price per unit.
  - setPrice
```
public void setPrice(java.math.BigDecimal price)
```
    Description copied from interface: OrderProductIf
    
    The price of a single product without tax or options.
    
    Specified by:
    
    setPrice in interface OrderProductIf
    
    Parameters:
    
    price - The price to set.
  - getProduct
```
public ProductIf getProduct()
```
    Specified by:
    
    getProduct in interface OrderProductIf
    
    Returns:
    
    Returns the product.
  - setProduct
```
public void setProduct(ProductIf product)
```
    Specified by:
    
    setProduct in interface OrderProductIf
    
    Parameters:
    
    product - The product to set.
  - getProductId
```
public int getProductId()
```
    Specified by:
    
    getProductId in interface OrderProductIf
    
    Returns:
    
    Returns the productId.
  - setProductId
```
public void setProductId(int productId)
```
    Specified by:
    
    setProductId in interface OrderProductIf
    
    Parameters:
    
    productId - The productId to set.
  - getQuantity
```
public int getQuantity()
```
    Specified by:
    
    getQuantity in interface OrderProductIf
    
    Returns:
    
    Returns the quantity.
  - setQuantity
```
public void setQuantity(int quantity)
```
    Specified by:
    
    setQuantity in interface OrderProductIf
    
    Parameters:
    
    quantity - The quantity to set.
  - getFinalPriceExTax
```
public java.math.BigDecimal getFinalPriceExTax()
```
    Specified by:
    
    getFinalPriceExTax in interface OrderProductIf
    
    Returns:
    
    Returns the finalPriceExTax.
  - setFinalPriceExTax
```
public void setFinalPriceExTax(java.math.BigDecimal finalPriceExTax)
```
    Specified by:
    
    setFinalPriceExTax in interface OrderProductIf
    
    Parameters:
    
    finalPriceExTax - The finalPriceExTax to set.
  - getFinalPriceIncTax
```
public java.math.BigDecimal getFinalPriceIncTax()
```
    Specified by:
    
    getFinalPriceIncTax in interface OrderProductIf
    
    Returns:
    
    Returns the finalPriceIncTax.
  - setFinalPriceIncTax
```
public void setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax)
```
    Specified by:
    
    setFinalPriceIncTax in interface OrderProductIf
    
    Parameters:
    
    finalPriceIncTax - The finalPriceIncTax to set.
  - getTaxRate
```
public java.math.BigDecimal getTaxRate()
```
    Description copied from interface: OrderProductIf
    
    The tax rate applied.
    
    Specified by:
    
    getTaxRate in interface OrderProductIf
    
    Returns:
    
    Returns the taxRate.
  - setTaxRate
```
public void setTaxRate(java.math.BigDecimal taxRate)
```
    Description copied from interface: OrderProductIf
    
    The tax rate applied.
    
    Specified by:
    
    setTaxRate in interface OrderProductIf
    
    Parameters:
    
    taxRate - The taxRate to set.
  - getTax
```
public java.math.BigDecimal getTax()
```
    Description copied from interface: OrderProductIf
    
    The amount of tax added.
    
    Specified by:
    
    getTax in interface OrderProductIf
    
    Returns:
    
    Returns the tax.
  - setTax
```
public void setTax(java.math.BigDecimal tax)
```
    Description copied from interface: OrderProductIf
    
    The amount of tax added.
    
    Specified by:
    
    setTax in interface OrderProductIf
    
    Parameters:
    
    tax - The tax to set.
  - getType
```
public int getType()
```
    Description copied from interface: OrderProductIf
    product type.
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE = a gift certificate product
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE = a product that has a schedule and can have bookings (i.e. a training course)
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE = a virtual product such as a service, warranty or donation
    Specified by:
    
    getType in interface OrderProductIf
    
    Returns:
    
    Returns the type.
  - setType
```
public void setType(int type)
```
    Description copied from interface: OrderProductIf
    product type. product type.
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE = a gift certificate product
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE = a product that has a schedule and can have bookings (i.e. a training course)
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE = a virtual product such as a service, warranty or donation
    Specified by:
    
    setType in interface OrderProductIf
    
    Parameters:
    
    type - The type to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface OrderProductIf
    
    Returns:
    
    Returns the custom1.
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface OrderProductIf
    
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface OrderProductIf
    
    Returns:
    
    Returns the custom2.
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface OrderProductIf
    
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
public java.lang.String getCustom3()
```
    Specified by:
    
    getCustom3 in interface OrderProductIf
    
    Returns:
    
    Returns the custom3.
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Specified by:
    
    setCustom3 in interface OrderProductIf
    
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
public java.lang.String getCustom4()
```
    Specified by:
    
    getCustom4 in interface OrderProductIf
    
    Returns:
    
    Returns the custom4.
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Specified by:
    
    setCustom4 in interface OrderProductIf
    
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
public java.lang.String getCustom5()
```
    Specified by:
    
    getCustom5 in interface OrderProductIf
    
    Returns:
    
    Returns the custom5.
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Specified by:
    
    setCustom5 in interface OrderProductIf
    
    Parameters:
    
    custom5 - The custom5 to set.
  - getCustom6
```
public java.lang.String getCustom6()
```
    Specified by:
    
    getCustom6 in interface OrderProductIf
    
    Returns:
    
    the custom6
  - setCustom6
```
public void setCustom6(java.lang.String custom6)
```
    Specified by:
    
    setCustom6 in interface OrderProductIf
    
    Parameters:
    
    custom6 - the custom6 to set
  - getCustom7
```
public java.lang.String getCustom7()
```
    Specified by:
    
    getCustom7 in interface OrderProductIf
    
    Returns:
    
    the custom7
  - setCustom7
```
public void setCustom7(java.lang.String custom7)
```
    Specified by:
    
    setCustom7 in interface OrderProductIf
    
    Parameters:
    
    custom7 - the custom7 to set
  - getCustom8
```
public java.lang.String getCustom8()
```
    Specified by:
    
    getCustom8 in interface OrderProductIf
    
    Returns:
    
    the custom8
  - setCustom8
```
public void setCustom8(java.lang.String custom8)
```
    Specified by:
    
    setCustom8 in interface OrderProductIf
    
    Parameters:
    
    custom8 - the custom8 to set
  - getCustom9
```
public java.lang.String getCustom9()
```
    Specified by:
    
    getCustom9 in interface OrderProductIf
    
    Returns:
    
    the custom9
  - setCustom9
```
public void setCustom9(java.lang.String custom9)
```
    Specified by:
    
    setCustom9 in interface OrderProductIf
    
    Parameters:
    
    custom9 - the custom9 to set
  - getCustom10
```
public java.lang.String getCustom10()
```
    Specified by:
    
    getCustom10 in interface OrderProductIf
    
    Returns:
    
    the custom10
  - setCustom10
```
public void setCustom10(java.lang.String custom10)
```
    Specified by:
    
    setCustom10 in interface OrderProductIf
    
    Parameters:
    
    custom10 - the custom10 to set
  - getCustom11
```
public java.lang.String getCustom11()
```
    Specified by:
    
    getCustom11 in interface OrderProductIf
    
    Returns:
    
    the custom11
  - setCustom11
```
public void setCustom11(java.lang.String custom11)
```
    Specified by:
    
    setCustom11 in interface OrderProductIf
    
    Parameters:
    
    custom11 - the custom11 to set
  - getPrice0
```
public java.math.BigDecimal getPrice0()
```
    Specified by:
    
    getPrice0 in interface OrderProductIf
    
    Returns:
    
    Returns the price0.
  - setPrice0
```
public void setPrice0(java.math.BigDecimal price0)
```
    Specified by:
    
    setPrice0 in interface OrderProductIf
    
    Parameters:
    
    price0 - The price0 to set.
  - getPrice1
```
public java.math.BigDecimal getPrice1()
```
    Specified by:
    
    getPrice1 in interface OrderProductIf
    
    Returns:
    
    Returns the price1.
  - setPrice1
```
public void setPrice1(java.math.BigDecimal price1)
```
    Specified by:
    
    setPrice1 in interface OrderProductIf
    
    Parameters:
    
    price1 - The price1 to set.
  - getPrice2
```
public java.math.BigDecimal getPrice2()
```
    Specified by:
    
    getPrice2 in interface OrderProductIf
    
    Returns:
    
    Returns the price2.
  - setPrice2
```
public void setPrice2(java.math.BigDecimal price2)
```
    Specified by:
    
    setPrice2 in interface OrderProductIf
    
    Parameters:
    
    price2 - The price2 to set.
  - getPrice3
```
public java.math.BigDecimal getPrice3()
```
    Specified by:
    
    getPrice3 in interface OrderProductIf
    
    Returns:
    
    Returns the price3.
  - setPrice3
```
public void setPrice3(java.math.BigDecimal price3)
```
    Specified by:
    
    setPrice3 in interface OrderProductIf
    
    Parameters:
    
    price3 - The price3 to set.
  - getSku
```
public java.lang.String getSku()
```
    Description copied from interface: OrderProductIf
    
    The SKU of the product
    
    Specified by:
    
    getSku in interface OrderProductIf
    
    Returns:
    
    the sku
  - setSku
```
public void setSku(java.lang.String sku)
```
    Description copied from interface: OrderProductIf
    
    The SKU of the product
    
    Specified by:
    
    setSku in interface OrderProductIf
    
    Parameters:
    
    sku - the sku to set
  - getState
```
public int getState()
```
    Description copied from interface: OrderProductIf
    The state of the product when added to the order. It can be user defined and can indicate for example if a product isn't in stock. When the order is created using the CreateOrder API call it is set to the following values:
    - com.konakart.bl.OrderMgr.ORD_PROD_IN_STOCK = The product is in stock
    - com.konakart.bl.OrderMgr.ORD_PROD_OUT_OF_STOCK_AVAILABLE_DATE_KNOWN = Product out of stock but with known availability date
    - com.konakart.bl.OrderMgr.ORD_PROD_OUT_OF_STOCK_AVAILABLE_DATE_UNKNOWN = Product out of stock and availability date unknown
    - com.konakart.bl.OrderMgr.ORD_PROD_PARTIALLY_OUT_OF_STOCK_AVAILABLE_DATE_KNOWN = Product not in stock with the required quantity but with known availability date
    - com.konakart.bl.OrderMgr.ORD_PROD_PARTIALLY_OUT_OF_STOCK_AVAILABLE_DATE_UNKNOWN = Product not in stock with the required quantity and availability date unknown
    - com.konakart.bl.OrderMgr.ORD_PROD_CUSTOMER_INFORMED_OF_DELIVERY_DATE = Product wasn't in stock but customer has been informed of the delivery date
    The value can be changed before saving the order.
    Specified by:
    
    getState in interface OrderProductIf
    
    Returns:
    
    the state
  - setState
```
public void setState(int state)
```
    Description copied from interface: OrderProductIf
    The state of the product when added to the order. It can be user defined and can indicate for example if a product isn't in stock. When the order is created using the CreateOrder API call it is set to the following values:
    - com.konakart.bl.OrderMgr.ORD_PROD_IN_STOCK = The product is in stock
    - com.konakart.bl.OrderMgr.ORD_PROD_OUT_OF_STOCK_AVAILABLE_DATE_KNOWN = Product out of stock but with known availability date
    - com.konakart.bl.OrderMgr.ORD_PROD_OUT_OF_STOCK_AVAILABLE_DATE_UNKNOWN = Product out of stock and availability date unknown
    - com.konakart.bl.OrderMgr.ORD_PROD_PARTIALLY_OUT_OF_STOCK_AVAILABLE_DATE_KNOWN = Product not in stock with the required quantity but with known availability date
    - com.konakart.bl.OrderMgr.ORD_PROD_PARTIALLY_OUT_OF_STOCK_AVAILABLE_DATE_UNKNOWN = Product not in stock with the required quantity and availability date unknown
    - com.konakart.bl.OrderMgr.ORD_PROD_CUSTOMER_INFORMED_OF_DELIVERY_DATE = Product wasn't in stock but customer has been informed of the delivery date
    The value can be changed before saving the order.
    Specified by:
    
    setState in interface OrderProductIf
    
    Parameters:
    
    state - the state to set
  - getWishListId
```
public int getWishListId()
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Returns:
    
    the wishListId
  - setWishListId
```
public void setWishListId(int wishListId)
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Parameters:
    
    wishListId - the wishListId to set
  - getWishListItemId
```
public int getWishListItemId()
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Returns:
    
    the wishListItemId
  - setWishListItemId
```
public void setWishListItemId(int wishListItemId)
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Parameters:
    
    wishListItemId - the wishListItemId to set
  - getDiscountPercent
```
public java.math.BigDecimal getDiscountPercent()
```
    Description copied from interface: OrderProductIf
    
    Used mainly with percentage tiered pricing discounts to store the percentage discount.
    
    Specified by:
    
    getDiscountPercent in interface OrderProductIf
    
    Returns:
    
    the discountPercent
  - setDiscountPercent
```
public void setDiscountPercent(java.math.BigDecimal discountPercent)
```
    Description copied from interface: OrderProductIf
    
    Used mainly with percentage tiered pricing discounts to store the percentage discount.
    
    Specified by:
    
    setDiscountPercent in interface OrderProductIf
    
    Parameters:
    
    discountPercent - the discountPercent to set
  - getWeight
```
public java.math.BigDecimal getWeight()
```
    Description copied from interface: OrderProductIf
    
    The weight of the product
    
    Specified by:
    
    getWeight in interface OrderProductIf
    
    Returns:
    
    the weight
  - setWeight
```
public void setWeight(java.math.BigDecimal weight)
```
    Description copied from interface: OrderProductIf
    
    The weight of the product
    
    Specified by:
    
    setWeight in interface OrderProductIf
    
    Parameters:
    
    weight - the weight to set
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Description copied from interface: OrderProductIf
    
    tax code used when looking up tax from an external service
    
    Specified by:
    
    getTaxCode in interface OrderProductIf
    
    Returns:
    
    the taxCode
  - setTaxCode
```
public void setTaxCode(java.lang.String taxCode)
```
    Description copied from interface: OrderProductIf
    
    tax code used when looking up tax from an external service
    
    Specified by:
    
    setTaxCode in interface OrderProductIf
    
    Parameters:
    
    taxCode - the taxCode to set
  - getReservationId
```
public int getReservationId()
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Returns:
    
    the reservationId
  - setReservationId
```
public void setReservationId(int reservationId)
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Parameters:
    
    reservationId - the reservationId to set
  - getQtyResrvdForResId
```
public int getQtyResrvdForResId()
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Returns:
    
    the qtyResrvdForResId
  - setQtyResrvdForResId
```
public void setQtyResrvdForResId(int qtyResrvdForResId)
```
    Description copied from interface: OrderProductIf
    
    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 OrderProductIf
    
    Parameters:
    
    qtyResrvdForResId - the qtyResrvdForResId to set
  - getRefundValue
```
public java.math.BigDecimal getRefundValue()
```
    The final unit price of a product having taken into account all discounts. May be used to calculate refunds.
    
    Specified by:
    
    getRefundValue in interface OrderProductIf
    
    Returns:
    
    the refundValue
  - setRefundValue
```
public void setRefundValue(java.math.BigDecimal refundValue)
```
    The final unit price of a product having taken into account all discounts. May be used to calculate refunds.
    
    Specified by:
    
    setRefundValue in interface OrderProductIf
    
    Parameters:
    
    refundValue - the refundValue to set
  - getRefundPoints
```
public int getRefundPoints()
```
    The number of points allocated for a single product. May be used to calculate refunds. Default value is -1 (not set).
    
    Specified by:
    
    getRefundPoints in interface OrderProductIf
    
    Returns:
    
    the refundPoints
  - setRefundPoints
```
public void setRefundPoints(int refundPoints)
```
    The number of points allocated for a single product. May be used to calculate refunds. Default value is -1 (not set).
    
    Specified by:
    
    setRefundPoints in interface OrderProductIf
    
    Parameters:
    
    refundPoints - the refundPoints to set
  - getCustomAttrs
```
public java.lang.String getCustomAttrs()
```
    Description copied from interface: OrderProductIf
    
    The XML form of the Custom Attributes
    
    Specified by:
    
    getCustomAttrs in interface OrderProductIf
    
    Returns:
    
    the customAttrs
  - setCustomAttrs
```
public void setCustomAttrs(java.lang.String customAttrs)
```
    Description copied from interface: OrderProductIf
    
    Set the XML form of the Custom Attributes
    
    Specified by:
    
    setCustomAttrs in interface OrderProductIf
    
    Parameters:
    
    customAttrs - the customAttrs to set
  - getCustomAttrArray
```
public ProdCustAttrIf[] getCustomAttrArray()
```
    Description copied from interface: OrderProductIf
    
    The array form of the Custom Attributes
    
    Specified by:
    
    getCustomAttrArray in interface OrderProductIf
    
    Returns:
    
    the customAttrArray
  - setCustomAttrArray
```
public void setCustomAttrArray(ProdCustAttrIf[] customAttrArray)
```
    Description copied from interface: OrderProductIf
    
    Set the array form of the Custom Attributes
    
    Specified by:
    
    setCustomAttrArray in interface OrderProductIf
    
    Parameters:
    
    customAttrArray - the customAttrArray to set
  - getTaxRateCode
```
public java.lang.String getTaxRateCode()
```
    Description copied from interface: OrderProductIf
    
    The code of the tax rate
    
    Specified by:
    
    getTaxRateCode in interface OrderProductIf
    
    Returns:
    
    the taxRateCode
  - setTaxRateCode
```
public void setTaxRateCode(java.lang.String taxRateCode)
```
    Description copied from interface: OrderProductIf
    
    The code of the tax rate
    
    Specified by:
    
    setTaxRateCode in interface OrderProductIf
    
    Parameters:
    
    taxRateCode - the taxRateCode to set

Class OrderProduct

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderProduct

OrderProduct

Method Detail

toString

calculateTotals

getId

setId

getModel

setModel

getName

setName

getOpts

setOpts

getOrder

setOrder

getOrderId

setOrderId

getPrice

getPricePerUnit

setPrice

getProduct

setProduct

getProductId

setProductId

getQuantity

setQuantity

getFinalPriceExTax

setFinalPriceExTax

getFinalPriceIncTax

setFinalPriceIncTax

getTaxRate

setTaxRate

getTax

setTax

getType

setType

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCustom6

setCustom6

getCustom7

setCustom7

getCustom8

setCustom8

getCustom9

setCustom9

getCustom10

setCustom10

getCustom11

setCustom11

getPrice0

setPrice0

getPrice1

setPrice1

getPrice2

setPrice2

getPrice3

setPrice3

getSku

setSku

getState

setState

getWishListId

setWishListId

getWishListItemId

setWishListItemId

getDiscountPercent