com.konakart.rmi.app
Class S_OrderProduct

java.lang.Object
  com.konakart.rmi.app.S_OrderProduct

All Implemented Interfaces:

java.io.Serializable

public class S_OrderProduct
extends java.lang.Object
implements java.io.Serializable

Links an order to a product. An order may have an array of these objects.

See Also:

Serialized Form

Constructor Summary

S_OrderProduct()

Method Summary

java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
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.
S_Option[]	getOpts() An array of Option objects defining how the details of the product.
S_Order	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()
S_Product	getProduct()
int	getProductId()
int	getQuantity()
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.
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	setCustom2(java.lang.String _custom2)
void	setCustom3(java.lang.String _custom3)
void	setCustom4(java.lang.String _custom4)
void	setCustom5(java.lang.String _custom5)
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(S_Option[] _opts) An array of Option objects defining how the details of the product.
void	setOrder(S_Order _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(S_Product _product)
void	setProductId(int _productId)
void	setQuantity(int _quantity)
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	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S_OrderProduct

public S_OrderProduct()

Method Detail

getId

public int getId()

Returns:

Returns the id.

setId

public void setId(int _id)

Parameters:

_id - The id to set.

getModel

public java.lang.String getModel()

The product model.

Returns:

Returns the model.

setModel

public void setModel(java.lang.String _model)

The product model.

Parameters:

_model - The model to set.

getName

public java.lang.String getName()

The product name.

Returns:

Returns the name.

setName

public void setName(java.lang.String _name)

The product name.

Parameters:

_name - The name to set.

getOpts

public S_Option[] 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

public void setOpts(S_Option[] _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

public S_Order getOrder()

Returns:

Returns the order.

setOrder

public void setOrder(S_Order _order)

Parameters:

_order - The order to set.

getOrderId

public int getOrderId()

Returns:

Returns the orderId.

setOrderId

public void setOrderId(int _orderId)

Parameters:

_orderId - The orderId to set.

getPrice

public java.math.BigDecimal getPrice()

The price of a single product without tax or options.

Returns:

Returns the price.

setPrice

public void setPrice(java.math.BigDecimal _price)

The price of a single product without tax or options.

Parameters:

_price - The price to set.

getProduct

public S_Product getProduct()

Returns:

Returns the product.

setProduct

public void setProduct(S_Product _product)

Parameters:

_product - The product to set.

getProductId

public int getProductId()

Returns:

Returns the productId.

setProductId

public void setProductId(int _productId)

Parameters:

_productId - The productId to set.

getQuantity

public int getQuantity()

Returns:

Returns the quantity.

setQuantity

public void setQuantity(int _quantity)

Parameters:

_quantity - The quantity to set.

getFinalPriceExTax

public java.math.BigDecimal getFinalPriceExTax()

Returns:

Returns the finalPriceExTax.

setFinalPriceExTax

public void setFinalPriceExTax(java.math.BigDecimal _finalPriceExTax)

Parameters:

_finalPriceExTax - The finalPriceExTax to set.

getFinalPriceIncTax

public java.math.BigDecimal getFinalPriceIncTax()

Returns:

Returns the finalPriceIncTax.

setFinalPriceIncTax

public void setFinalPriceIncTax(java.math.BigDecimal _finalPriceIncTax)

Parameters:

_finalPriceIncTax - The finalPriceIncTax to set.

getTaxRate

public java.math.BigDecimal getTaxRate()

The tax rate applied.

Returns:

Returns the taxRate.

setTaxRate

public void setTaxRate(java.math.BigDecimal _taxRate)

The tax rate applied.

Parameters:

_taxRate - The taxRate to set.

getTax

public java.math.BigDecimal getTax()

The amount of tax added.

Returns:

Returns the tax.

setTax

public void setTax(java.math.BigDecimal _tax)

The amount of tax added.

Parameters:

_tax - The tax to set.

getType

public int getType()

product type.

• 0 = physical product
• 1 = digital download product

Returns:

Returns the type.

setType

public void setType(int _type)

product type.

• 0 = physical product
• 1 = digital download product

Parameters:

_type - The type to set.

getCustom1

public java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String _custom4)

Parameters:

_custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String _custom5)

Parameters:

_custom5 - The custom5 to set.

getPrice0

public java.math.BigDecimal getPrice0()

Returns:

Returns the price0.

setPrice0

public void setPrice0(java.math.BigDecimal _price0)

Parameters:

_price0 - The price0 to set.

getPrice1

public java.math.BigDecimal getPrice1()

Returns:

Returns the price1.

setPrice1

public void setPrice1(java.math.BigDecimal _price1)

Parameters:

_price1 - The price1 to set.

getPrice2

public java.math.BigDecimal getPrice2()

Returns:

Returns the price2.

setPrice2

public void setPrice2(java.math.BigDecimal _price2)

Parameters:

_price2 - The price2 to set.

getPrice3

public java.math.BigDecimal getPrice3()

Returns:

Returns the price3.

setPrice3

public void setPrice3(java.math.BigDecimal _price3)

Parameters:

_price3 - The price3 to set.

getSku

public java.lang.String getSku()

The SKU of the product

Returns:

the sku

setSku

public void setSku(java.lang.String _sku)

The SKU of the product

Parameters:

_sku - the sku to set

getState

public 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

public 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

public 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

public 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

public 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

public 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

public java.math.BigDecimal getDiscountPercent()

Used mainly with percentage tiered pricing discounts to store the percentage discount.

Returns:

the discountPercent

setDiscountPercent

public 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

public java.math.BigDecimal getWeight()

The weight of the product

Returns:

the weight return the weight of the product

setWeight

public void setWeight(java.math.BigDecimal _weight)

The weight of the product

Parameters:

_weight - the weight to set

getTaxCode

public java.lang.String getTaxCode()

tax code used when looking up tax from an external service

Returns:

the taxCode

setTaxCode

public void setTaxCode(java.lang.String _taxCode)

tax code used when looking up tax from an external service

Parameters:

_taxCode - the taxCode to set