com.ibm.commerce.foundation.common.datatypes

Interface OrderChargesType

public interface OrderChargesType

A representation of the model object 'Order Charges Type'. Type definition of the order's charges.

The following features are supported:

• Grand Total
• Total Product Price
• Total Adjustment
• Generic Total
• Adjustment
• Total Shipping Charge
• Total Sales Tax
• Total Shipping Tax
• Total Tax By Tax Category
• User Data

See Also:

CommerceFoundationPackage.getOrderChargesType()

Method Summary

Modifier and Type	Method and Description
java.util.List	getAdjustment() Returns the value of the 'Adjustment' containment reference list.
java.util.List	getGenericTotal() Returns the value of the 'Generic Total' containment reference list.
MonetaryAmountType	getGrandTotal() Returns the value of the 'Grand Total' containment reference.
MonetaryAmountType	getTotalAdjustment() Returns the value of the 'Total Adjustment' containment reference.
MonetaryAmountType	getTotalProductPrice() Returns the value of the 'Total Product Price' containment reference.
MonetaryAmountType	getTotalSalesTax() Returns the value of the 'Total Sales Tax' containment reference.
MonetaryAmountType	getTotalShippingCharge() Returns the value of the 'Total Shipping Charge' containment reference.
MonetaryAmountType	getTotalShippingTax() Returns the value of the 'Total Shipping Tax' containment reference.
java.util.List	getTotalTaxByTaxCategory() Returns the value of the 'Total Tax By Tax Category' containment reference list.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
void	setGrandTotal(MonetaryAmountType value) Sets the value of the 'Grand Total' containment reference.
void	setTotalAdjustment(MonetaryAmountType value) Sets the value of the 'Total Adjustment' containment reference.
void	setTotalProductPrice(MonetaryAmountType value) Sets the value of the 'Total Product Price' containment reference.
void	setTotalSalesTax(MonetaryAmountType value) Sets the value of the 'Total Sales Tax' containment reference.
void	setTotalShippingCharge(MonetaryAmountType value) Sets the value of the 'Total Shipping Charge' containment reference.
void	setTotalShippingTax(MonetaryAmountType value) Sets the value of the 'Total Shipping Tax' containment reference.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.

Method Detail

getGrandTotal

MonetaryAmountType getGrandTotal()

Returns the value of the 'Grand Total' containment reference. The grand total.

Returns:

the value of the 'Grand Total' containment reference.

See Also:

setGrandTotal(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_GrandTotal()

setGrandTotal

void setGrandTotal(MonetaryAmountType value)

Sets the value of the 'Grand Total' containment reference.

Parameters:

value - the new value of the 'Grand Total' containment reference.

See Also:

getGrandTotal()

getTotalProductPrice

MonetaryAmountType getTotalProductPrice()

Returns the value of the 'Total Product Price' containment reference. The total product price.

Returns:

the value of the 'Total Product Price' containment reference.

See Also:

setTotalProductPrice(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_TotalProductPrice()

setTotalProductPrice

void setTotalProductPrice(MonetaryAmountType value)

Sets the value of the 'Total Product Price' containment reference.

Parameters:

value - the new value of the 'Total Product Price' containment reference.

See Also:

getTotalProductPrice()

getTotalAdjustment

MonetaryAmountType getTotalAdjustment()

Returns the value of the 'Total Adjustment' containment reference. The order total adjustment.

Returns:

the value of the 'Total Adjustment' containment reference.

See Also:

setTotalAdjustment(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_TotalAdjustment()

setTotalAdjustment

void setTotalAdjustment(MonetaryAmountType value)

Sets the value of the 'Total Adjustment' containment reference.

Parameters:

value - the new value of the 'Total Adjustment' containment reference.

See Also:

getTotalAdjustment()

getGenericTotal

java.util.List getGenericTotal()

Returns the value of the 'Generic Total' containment reference list. The list contents are of type GenericTotalType. Generic total of the order (i.e. unit price multiplied by quantity).

Returns:

the value of the 'Generic Total' containment reference list.

See Also:

CommerceFoundationPackage.getOrderChargesType_GenericTotal()

getAdjustment

java.util.List getAdjustment()

Returns the value of the 'Adjustment' containment reference list. The list contents are of type AdjustmentType. The order adjustment.

Returns:

the value of the 'Adjustment' containment reference list.

See Also:

CommerceFoundationPackage.getOrderChargesType_Adjustment()

getTotalShippingCharge

MonetaryAmountType getTotalShippingCharge()

Returns the value of the 'Total Shipping Charge' containment reference. The total shipping charge.

Returns:

the value of the 'Total Shipping Charge' containment reference.

See Also:

setTotalShippingCharge(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_TotalShippingCharge()

setTotalShippingCharge

void setTotalShippingCharge(MonetaryAmountType value)

Sets the value of the 'Total Shipping Charge' containment reference.

Parameters:

value - the new value of the 'Total Shipping Charge' containment reference.

See Also:

getTotalShippingCharge()

getTotalSalesTax

MonetaryAmountType getTotalSalesTax()

Returns the value of the 'Total Sales Tax' containment reference. The total sales tax.

Returns:

the value of the 'Total Sales Tax' containment reference.

See Also:

setTotalSalesTax(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_TotalSalesTax()

setTotalSalesTax

void setTotalSalesTax(MonetaryAmountType value)

Sets the value of the 'Total Sales Tax' containment reference.

Parameters:

value - the new value of the 'Total Sales Tax' containment reference.

See Also:

getTotalSalesTax()

getTotalShippingTax

MonetaryAmountType getTotalShippingTax()

Returns the value of the 'Total Shipping Tax' containment reference. The total shipping tax.

Returns:

the value of the 'Total Shipping Tax' containment reference.

See Also:

setTotalShippingTax(MonetaryAmountType), CommerceFoundationPackage.getOrderChargesType_TotalShippingTax()

setTotalShippingTax

void setTotalShippingTax(MonetaryAmountType value)

Sets the value of the 'Total Shipping Tax' containment reference.

Parameters:

value - the new value of the 'Total Shipping Tax' containment reference.

See Also:

getTotalShippingTax()

getTotalTaxByTaxCategory

java.util.List getTotalTaxByTaxCategory()

Returns the value of the 'Total Tax By Tax Category' containment reference list. The list contents are of type TaxByTaxCategoryType. The total tax amount for each tax category.

Returns:

the value of the 'Total Tax By Tax Category' containment reference list.

See Also:

CommerceFoundationPackage.getOrderChargesType_TotalTaxByTaxCategory()

getUserData

UserDataType getUserData()

Returns the value of the 'User Data' containment reference. The user data area.

Returns:

the value of the 'User Data' containment reference.

See Also:

setUserData(UserDataType), CommerceFoundationPackage.getOrderChargesType_UserData()

setUserData

void setUserData(UserDataType value)

Sets the value of the 'User Data' containment reference.

Parameters:

value - the new value of the 'User Data' containment reference.

See Also:

getUserData()