atg.commerce.pricing.result
Class OrderPrice

java.lang.Object
  atg.commerce.pricing.result.OrderPrice

public class OrderPrice
extends java.lang.Object

Contains the following information about the price of an Order:

• orderId, the ID of the order
• currencyCode, the type of currency
• rawSubtotal, the undiscounted subtotal of the order
• subtotal, the discounted subtotal of the order
• tax, the tax on the order
• shipping, the shipping cost of the order
• total, the current working total, including all discounts
• discountAmount, the total amount of order discounts
• discounted, boolean indicating if the order was discounted
• adjustments, an array of all the discounts
• taxPrice, an object describing the taxes
• shippingPrices, an array of all the shipping costs
• itemPrices, an array of all the item costs

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

OrderPrice()

Method Summary

PriceAdjustment[]	getAdjustments() an array of all the discounts
java.lang.String	getCurrencyCode() the currency code
double	getDiscountAmount() the total amount of order discounts
ItemPrice[]	getItemPrices() an array of the item costs
java.lang.String	getOrderId() the order id
double	getRawSubtotal() the undiscounted subtotal of the order
double	getShipping() the shipping cost of the order
ShippingPrice[]	getShippingPrices() an array of the shipping costs
double	getSubtotal() the discounted subtotal of the order
double	getTax() the tax on the order
TaxPrice	getTaxPrice() an object describing the taxes
double	getTotalPrice() the current working total, including all discounts
boolean	isDiscounted() boolean indicating if the order was discounted
void	setAdjustments(PriceAdjustment[] pAdjustments) an array of all the discounts
void	setCurrencyCode(java.lang.String pCurrencyCode) the currency code
void	setDiscountAmount(double pDiscountAmount) the total amount of order discounts
void	setDiscounted(boolean pDiscounted) boolean indicating if the order was discounted
void	setItemPrices(ItemPrice[] pItemPrices) an array of the item costs
void	setOrderId(java.lang.String pOrderId) the order id
void	setRawSubtotal(double pRawSubtotal) the undiscounted subtotal of the order
void	setShipping(double pShipping) the shipping cost of the order
void	setShippingPrices(ShippingPrice[] pShippingPrices) an array of the shipping costs
void	setSubtotal(double pSubtotal) the discounted subtotal of the order
void	setTax(double pTax) the tax on the order
void	setTaxPrice(TaxPrice pTaxPrice) an object describing the taxes
void	setTotalPrice(double pTotalPrice) the current working total, including all discounts
java.lang.String	toString() Returns a string form of this price information

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

OrderPrice

public OrderPrice()

Method Detail

setOrderId

public void setOrderId(java.lang.String pOrderId)

the order id

Parameters:

pOrderId - new value to set

getOrderId

public java.lang.String getOrderId()

the order id

Returns:

property OrderId

setCurrencyCode

public void setCurrencyCode(java.lang.String pCurrencyCode)

the currency code

Parameters:

pCurrencyCode - new value to set

getCurrencyCode

public java.lang.String getCurrencyCode()

the currency code

Returns:

property CurrencyCode

setRawSubtotal

public void setRawSubtotal(double pRawSubtotal)

the undiscounted subtotal of the order

Parameters:

pRawSubtotal - new value to set

getRawSubtotal

public double getRawSubtotal()

the undiscounted subtotal of the order

Returns:

property RawSubtotal

setSubtotal

public void setSubtotal(double pSubtotal)

the discounted subtotal of the order

Parameters:

pSubtotal - new value to set

getSubtotal

public double getSubtotal()

the discounted subtotal of the order

Returns:

property Subtotal

setTax

public void setTax(double pTax)

the tax on the order

Parameters:

pTax - new value to set

getTax

public double getTax()

the tax on the order

Returns:

property Tax

setShipping

public void setShipping(double pShipping)

the shipping cost of the order

Parameters:

pShipping - new value to set

getShipping

public double getShipping()

the shipping cost of the order

Returns:

property Shipping

setTotalPrice

public void setTotalPrice(double pTotalPrice)

the current working total, including all discounts

Parameters:

pTotalPrice - new value to set

getTotalPrice

public double getTotalPrice()

the current working total, including all discounts

Returns:

property TotalPrice

setDiscountAmount

public void setDiscountAmount(double pDiscountAmount)

the total amount of order discounts

Parameters:

pDiscountAmount - new value to set

getDiscountAmount

public double getDiscountAmount()

the total amount of order discounts

Returns:

property DiscountAmount

setDiscounted

public void setDiscounted(boolean pDiscounted)

boolean indicating if the order was discounted

Parameters:

pDiscounted - new value to set

isDiscounted

public boolean isDiscounted()

boolean indicating if the order was discounted

Returns:

property Discounted

setAdjustments

public void setAdjustments(PriceAdjustment[] pAdjustments)

an array of all the discounts

Parameters:

pAdjustments - new value to set

getAdjustments

public PriceAdjustment[] getAdjustments()

an array of all the discounts

Returns:

property Adjustments

setTaxPrice

public void setTaxPrice(TaxPrice pTaxPrice)

an object describing the taxes

Parameters:

pTaxPrice - new value to set

getTaxPrice

public TaxPrice getTaxPrice()

an object describing the taxes

Returns:

property TaxPrice

setShippingPrices

public void setShippingPrices(ShippingPrice[] pShippingPrices)

an array of the shipping costs

Parameters:

pShippingPrices - new value to set

getShippingPrices

public ShippingPrice[] getShippingPrices()

an array of the shipping costs

Returns:

property ShippingPrices

setItemPrices

public void setItemPrices(ItemPrice[] pItemPrices)

an array of the item costs

Parameters:

pItemPrices - new value to set

getItemPrices

public ItemPrice[] getItemPrices()

an array of the item costs

Returns:

property ItemPrices

toString

public java.lang.String toString()

Returns a string form of this price information

Overrides:

toString in class java.lang.Object