public final class CSOrderItemContent extends CSItemContent
CSOrderItem
object.
set/get
methods within CSOrderItem
provide access to this content data and so there
should not typically be any need to explicitly use the set/get
methods supplied here.
CSOrderItem
,
Serialized FormConstructor and Description |
---|
CSOrderItemContent()
Creates an empty
CSOrderItemContent object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSOrderItemContent object is the same as that
contained within the one supplied. |
java.lang.String |
getBasketItemUserData()
Gets the basket item user data of the order item.
|
java.lang.Double |
getCountryTotal()
Gets the overall total price of the order item in the currency of the invoice country.
|
java.lang.Double |
getCountryTotalDiscount()
Gets the amount of discount on the order item in the currency of the invoice country.
|
java.lang.Double |
getCountryTotalTax()
Gets the total VAT applied to the order item in the currency of the invoice country.
|
java.lang.Double |
getCountryUnitPrice()
Gets the net unit price of the order item in the currency of the invoice country.
|
java.lang.String |
getDescription()
Gets the description of the order item.
|
java.lang.String |
getDiscountSchemeName()
Gets the name of the discount scheme to be applied to the order item.
|
int |
getLineNumber()
Gets the line number of the order item to be used as key information.
|
java.lang.String |
getLineType()
Gets the line type of the order item.
|
int |
getOrderID()
Gets the ID of the order associated with the order item to be used as key information.
|
CSOrderItemDispatchMultiple |
getOrderItemDispatchMultiple()
Gets the
CSOrderItemDispatchMultiple object containing the CSOrderItemDispatch objects associated
with this order item. |
java.lang.String |
getProductOptionUserData()
Gets the product option user data of the order item.
|
java.lang.String |
getProductTypeUserData()
Gets the product type user data of the order item.
|
java.lang.Integer |
getQuantity()
Gets the quantity of the order item.
|
java.lang.String |
getStockCode()
Gets the stock code of the order item.
|
int |
getTaxSchemeID()
Gets the ID of the VAT scheme to be applied to the order item.
|
java.lang.String |
getTaxSchemeName()
Gets the name of the VAT scheme to be applied to the order item.
|
double |
getTotal()
Gets the overall total price of the order item.
|
java.lang.Double |
getTotalDiscount()
Gets the total discount applied to the order item.
|
java.lang.Double |
getTotalTax()
Gets the total tax applied to the order item.
|
java.lang.Double |
getUnitPrice()
Gets the unit price of the order item.
|
void |
setBasketItemUserData(java.lang.String strBasketItemUserData)
Sets the basket item user data of the order item.
|
void |
setCountryTotal(java.lang.Double nCountryTotal)
Sets the overall total price of the order item in the currency of the invoice country.
|
void |
setCountryTotalDiscount(java.lang.Double nCountryTotalDiscount)
Sets the amount of discount on the order item in the currency of the invoice country.
|
void |
setCountryTotalTax(java.lang.Double nCountryTotalTax)
Sets the total VAT applied to the order item in the currency of the invoice country.
|
void |
setCountryUnitPrice(java.lang.Double nCountryUnitPrice)
Sets the net unit price of the order item in the currency of the invoice country.
|
void |
setDescription(java.lang.String strDescription)
Sets the description of the order item.
|
void |
setDiscountSchemeName(java.lang.String strDiscountSchemeName)
Sets the name of the discount scheme to be applied to the order item.
|
void |
setLineNumber(int strLineNumber)
Sets the line number of the order item to be used as key information.
|
void |
setLineType(java.lang.String strLineType)
Sets the line type of the order item.
|
void |
setOrderID(int nOrderID)
Sets the ID of the order associated with the order item to be used as key information.
|
void |
setOrderItemDispatchMultiple(CSOrderItemDispatchMultiple objOrderItemDispatchMultiple)
Sets the
CSOrderItemDispatchMultiple object containing the CSOrderItemDispatch objects associated
with this order item. |
void |
setProductOptionUserData(java.lang.String strProductOptionUserData)
Sets the product option user data of the order item.
|
void |
setProductTypeUserData(java.lang.String strProductTypeUserData)
Sets the product type user data of the order item.
|
void |
setQuantity(java.lang.Integer nQuantity)
Sets the quantity of the order item.
|
void |
setStockCode(java.lang.String strStockCode)
Sets the stock code of the order item.
|
void |
setTaxSchemeID(int nTaxSchemeId)
Sets the ID of the VAT scheme to be applied to the order item.
|
void |
setTaxSchemeName(java.lang.String strTaxSchemeName)
Sets the name of the VAT scheme to be applied to the order item.
|
void |
setTotal(double nTotal)
Sets the overall total price of the order item.
|
void |
setTotalDiscount(java.lang.Double nTotalDiscount)
Sets the total discount applied to the order item.
|
void |
setTotalTax(java.lang.Double nTotalTax)
Sets the total tax applied to the order item.
|
void |
setUnitPrice(java.lang.Double nUnitPrice)
Sets the unit price of the order item.
|
void |
unset()
Clear all the content details of the
CSOrderItemContent object. |
clone, getID, setID, toString
public CSOrderItemContent()
CSOrderItemContent
object.public int getOrderID()
public void setOrderID(int nOrderID)
nOrderID
- the order item's associated order ID to be used as key information.public int getLineNumber()
public void setLineNumber(int strLineNumber)
strLineNumber
- the order item's line number to be used as key information.public java.lang.String getLineType()
public void setLineType(java.lang.String strLineType)
The valid line types are as follows :
Item
Discount
Shipping
Total
strLineType
- the order item's line type.public java.lang.String getStockCode()
public void setStockCode(java.lang.String strStockCode)
strStockCode
- the order item's stock code.public java.lang.String getDescription()
public void setDescription(java.lang.String strDescription)
strDescription
- the order item's description.public java.lang.Double getUnitPrice()
public void setUnitPrice(java.lang.Double nUnitPrice)
nUnitPrice
- the order item's unit price.public java.lang.Integer getQuantity()
public void setQuantity(java.lang.Integer nQuantity)
nQuantity
- the order item's quantity.public java.lang.String getDiscountSchemeName()
public void setDiscountSchemeName(java.lang.String strDiscountSchemeName)
strDiscountSchemeName
- the order item's discount scheme name.public java.lang.Double getTotalDiscount()
public void setTotalDiscount(java.lang.Double nTotalDiscount)
nTotalDiscount
- the order item's total discount.public int getTaxSchemeID()
public void setTaxSchemeID(int nTaxSchemeId)
nTaxSchemeId
- the order item's VAT scheme ID.public java.lang.String getTaxSchemeName()
public void setTaxSchemeName(java.lang.String strTaxSchemeName)
strTaxSchemeName
- the order item's VAT scheme name.public java.lang.Double getTotalTax()
public void setTotalTax(java.lang.Double nTotalTax)
nTotalTax
- the order item's total tax.public double getTotal()
public void setTotal(double nTotal)
nTotal
- the order item's overall total price.public java.lang.Double getCountryUnitPrice()
public void setCountryUnitPrice(java.lang.Double nCountryUnitPrice)
nCountryUnitPrice
- the order item's net unit price in the currency of the invoice country.public java.lang.Double getCountryTotalDiscount()
public void setCountryTotalDiscount(java.lang.Double nCountryTotalDiscount)
nCountryTotalDiscount
- the order item's amount of discount in the currency of the invoice country.public java.lang.Double getCountryTotalTax()
public void setCountryTotalTax(java.lang.Double nCountryTotalTax)
nCountryTotalTax
- the order item's applied VAT in the currency of the invoice country.public java.lang.Double getCountryTotal()
public void setCountryTotal(java.lang.Double nCountryTotal)
nCountryTotal
- the order item's overall total price in the currency of the invoice country.public java.lang.String getProductOptionUserData()
public void setProductOptionUserData(java.lang.String strProductOptionUserData)
strProductOptionUserData
- the order item's product option user data.public java.lang.String getProductTypeUserData()
public void setProductTypeUserData(java.lang.String strProductTypeUserData)
strProductTypeUserData
- the order item's product type user data.public java.lang.String getBasketItemUserData()
public void setBasketItemUserData(java.lang.String strBasketItemUserData)
strBasketItemUserData
- the order item's basket item user data.public CSOrderItemDispatchMultiple getOrderItemDispatchMultiple()
CSOrderItemDispatchMultiple
object containing the CSOrderItemDispatch
objects associated
with this order item.
CSOrderItemDispatchMultiple
populated with CSOrderItemDispatch
objects which represent
order item dispatches associated with this order item.public void setOrderItemDispatchMultiple(CSOrderItemDispatchMultiple objOrderItemDispatchMultiple)
CSOrderItemDispatchMultiple
object containing the CSOrderItemDispatch
objects associated
with this order item.
objOrderItemDispatchMultiple
- a CSOrderItemDispatchMultiple
object populated with CSOrderItemDispatch
objects each
of which represents an order item dispatch associated with this order item.public void unset()
CSOrderItemContent
object.unset
in class CSItemContent
public boolean equals(java.lang.Object obj)
CSOrderItemContent
object is the same as that
contained within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSOrderItemContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.