OrderProductIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

OrderProduct
```
public interface OrderProductIf
```
Links an order to a product. An order may have an array of these objects.

Method Summary

All Methods Instance Methods Abstract Methods
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()`
`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()`
`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.

- Method Detail
  - getId
```
int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getModel
```
java.lang.String getModel()
```
    The product model.
    
    Returns:
    
    Returns the model.
  - setModel
```
void setModel(java.lang.String model)
```
    The product model.
    
    Parameters:
    
    model - The model to set.
  - getName
```
java.lang.String getName()
```
    The product name.
    
    Returns:
    
    Returns the name.
  - setName
```
void setName(java.lang.String name)
```
    The product name.
    
    Parameters:
    
    name - The name to set.
  - getOpts
```
OptionIf[] getOpts()
```
    An array of Option objects defining how the details of the product. e.g. color, size, amount of memory etc.
    
    Returns:
    
    Returns the opts.
  - setOpts
```
void setOpts(OptionIf[] opts)
```
    An array of Option objects defining how the details of the product. e.g. color, size, amount of memory etc.
    
    Parameters:
    
    opts - The opts to set.
  - getOrder
```
OrderIf getOrder()
```
    Returns:
    
    Returns the order.
  - setOrder
```
void setOrder(OrderIf order)
```
    Parameters:
    
    order - The order to set.
  - getOrderId
```
int getOrderId()
```
    Returns:
    
    Returns the orderId.
  - setOrderId
```
void setOrderId(int orderId)
```
    Parameters:
    
    orderId - The orderId to set.
  - getPrice
```
java.math.BigDecimal getPrice()
```
    The price of a single product without tax or options.
    
    Returns:
    
    Returns the price.
  - setPrice
```
void setPrice(java.math.BigDecimal price)
```
    The price of a single product without tax or options.
    
    Parameters:
    
    price - The price 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()
```
    Returns:
    
    Returns the finalPriceExTax.
  - setFinalPriceExTax
```
void setFinalPriceExTax(java.math.BigDecimal finalPriceExTax)
```
    Parameters:
    
    finalPriceExTax - The finalPriceExTax to set.
  - getFinalPriceIncTax
```
java.math.BigDecimal getFinalPriceIncTax()
```
    Returns:
    
    Returns the finalPriceIncTax.
  - setFinalPriceIncTax
```
void setFinalPriceIncTax(java.math.BigDecimal finalPriceIncTax)
```
    Parameters:
    
    finalPriceIncTax - The finalPriceIncTax to set.
  - getTaxRate
```
java.math.BigDecimal getTaxRate()
```
    The tax rate applied.
    
    Returns:
    
    Returns the taxRate.
  - setTaxRate
```
void setTaxRate(java.math.BigDecimal taxRate)
```
    The tax rate applied.
    
    Parameters:
    
    taxRate - The taxRate to set.
  - getTax
```
java.math.BigDecimal getTax()
```
    The amount of tax added.
    
    Returns:
    
    Returns the tax.
  - setTax
```
void setTax(java.math.BigDecimal tax)
```
    The amount of tax added.
    
    Parameters:
    
    tax - The tax to set.
  - getType
```
int getType()
```
    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
    Returns:
    
    Returns the type.
  - setType
```
void setType(int type)
```
    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
    Parameters:
    
    type - The type 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
  - getPrice0
```
java.math.BigDecimal getPrice0()
```
    Returns:
    
    Returns the price0.
  - setPrice0
```
void setPrice0(java.math.BigDecimal price0)
```
    Parameters:
    
    price0 - The price0 to set.
  - getPrice1
```
java.math.BigDecimal getPrice1()
```
    Returns:
    
    Returns the price1.
  - setPrice1
```
void setPrice1(java.math.BigDecimal price1)
```
    Parameters:
    
    price1 - The price1 to set.
  - getPrice2
```
java.math.BigDecimal getPrice2()
```
    Returns:
    
    Returns the price2.
  - setPrice2
```
void setPrice2(java.math.BigDecimal price2)
```
    Parameters:
    
    price2 - The price2 to set.
  - getPrice3
```
java.math.BigDecimal getPrice3()
```
    Returns:
    
    Returns the price3.
  - setPrice3
```
void setPrice3(java.math.BigDecimal price3)
```
    Parameters:
    
    price3 - The price3 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
  - getState
```
int getState()
```
    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.
    Returns:
    
    the state
  - setState
```
void setState(int state)
```
    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.
    Parameters:
    
    state - the state 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
  - getDiscountPercent
```
java.math.BigDecimal getDiscountPercent()
```
    Used mainly with percentage tiered pricing discounts to store the percentage discount.
    
    Returns:
    
    the discountPercent
  - setDiscountPercent
```
void setDiscountPercent(java.math.BigDecimal discountPercent)
```
    Used mainly with percentage tiered pricing discounts to store the percentage discount.
    
    Parameters:
    
    discountPercent - the discountPercent to set
  - getWeight
```
java.math.BigDecimal getWeight()
```
    The weight of the product
    
    Returns:
    
    the weight return the weight of the product
  - setWeight
```
void setWeight(java.math.BigDecimal weight)
```
    The weight of the product
    
    Parameters:
    
    weight - the weight to set
  - getTaxCode
```
java.lang.String getTaxCode()
```
    tax code used when looking up tax from an external service
    
    Returns:
    
    the taxCode
  - setTaxCode
```
void setTaxCode(java.lang.String taxCode)
```
    tax code used when looking up tax from an external service
    
    Parameters:
    
    taxCode - the taxCode 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
  - getRefundValue
```
java.math.BigDecimal getRefundValue()
```
    The final unit price of a product having taken into account all discounts. May be used to calculate refunds.
    
    Returns:
    
    the refundValue
  - setRefundValue
```
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.
    
    Parameters:
    
    refundValue - the refundValue to set
  - getRefundPoints
```
int getRefundPoints()
```
    The number of points allocated for a single product. May be used to calculate refunds. Default value is -1 (not set).
    
    Returns:
    
    the refundPoints
  - setRefundPoints
```
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).
    
    Parameters:
    
    refundPoints - the refundPoints to set
  - getCustomAttrs
```
java.lang.String getCustomAttrs()
```
    The XML form of the Custom Attributes
    
    Returns:
    
    the customAttrs
  - setCustomAttrs
```
void setCustomAttrs(java.lang.String customAttrs)
```
    Set the XML form of the Custom Attributes
    
    Parameters:
    
    customAttrs - the customAttrs to set
  - getCustomAttrArray
```
ProdCustAttrIf[] getCustomAttrArray()
```
    The array form of the Custom Attributes
    
    Returns:
    
    the customAttrArray
  - setCustomAttrArray
```
void setCustomAttrArray(ProdCustAttrIf[] customAttrArray)
```
    Set the array form of the Custom Attributes
    
    Parameters:
    
    customAttrArray - the customAttrArray to set
  - getTaxRateCode
```
java.lang.String getTaxRateCode()
```
    The code of the tax rate
    
    Returns:
    
    the taxRateCode
  - setTaxRateCode
```
void setTaxRateCode(java.lang.String taxRateCode)
```
    The code of the tax rate
    
    Parameters:
    
    taxRateCode - the taxRateCode to set

Interface OrderProductIf

Method Summary

Method Detail

getId

setId

getModel

setModel

getName

setName

getOpts

setOpts

getOrder

setOrder

getOrderId

setOrderId

getPrice

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

setDiscountPercent

getWeight

setWeight

getTaxCode

setTaxCode

getReservationId

setReservationId

getQtyResrvdForResId