com.bea.commerce.ebusiness.price.service
Interface PricingReply

public interface PricingReply

extends java.io.Serializable

PricingReply is used to maintain the results of a PriceService pricing operation. Not all fields are populated by all pricing operations, see the Price service documentation for details.

See Also:

PriceService, PricingRequest, Money

Method Summary

Money	getActualShipping() Retrieves the actual shipping cost after discounting.
java.io.Serializable	getAttribute(java.lang.String name) Retrieves the value of a reply attribute by name.
Money	getBaseShipping() Retrieves the base shipping cost before discounting.
java.util.Set	getGlobalDiscounts() Returns the Set of QualificationDiscountId objects corresponding to the global discounts applied during the pricing operation.
Line[]	getLines() Retrieves the Line items for this pricing operation.
java.util.List	getOrderDiscounts() Retrieves a List of OrderAdjustment objects corresponding to the order discounts applied to the subtotal.
Quote	getQuote() Returns the Quote object for the pricing operation.
java.util.List	getShippingDiscounts() Retrieves a List of OrderAdjustment objects corresponding to shipping adjustments (base shipping and any shipping discounts).
Money	getSubtotal() Retrieves the subtotal for the pricing request.
Money	getTotal() Retrieves the total for the pricing request.
java.util.Set	getUserDiscounts() Returns the Set of QualificationDiscountId objects corresponding to the user discounts applied during the pricing operation.

Method Detail

getLines

public Line[] getLines()

Retrieves the Line items for this pricing operation. Line items that have been adjusted will have one(1) to many DiscountPresentation objects attached to the Line.

Returns:

an array of Line items.

See Also:

Line

getAttribute

public java.io.Serializable getAttribute(java.lang.String name)

Retrieves the value of a reply attribute by name. The semantics of this method are the same as the get() method in the java.util.Map interface. Attributes allow for customization of the PricingReply without changing the interface.

Parameters:

name - the name of a reply attribute to get the value for.

Returns:

the value for the named reply attribute.

See Also:

Map

getActualShipping

public Money getActualShipping()

Retrieves the actual shipping cost after discounting.

See Also:

Money

getBaseShipping

public Money getBaseShipping()

Retrieves the base shipping cost before discounting.

See Also:

Money

getSubtotal

public Money getSubtotal()

Retrieves the subtotal for the pricing request. More precisely the sum of the Line item costs.

See Also:

Money

getTotal

public Money getTotal()

Retrieves the total for the pricing request. More precisely, subtotal plus any order adjustments (including shipping). Tax is not included.

See Also:

Money

getOrderDiscounts

public java.util.List getOrderDiscounts()

Retrieves a List of OrderAdjustment objects corresponding to the order discounts applied to the subtotal. The value returned may be null if no order discounts exist.

Returns:

a List of OrderAdjustment objects or null if no order discounts were applied during the pricing operation.

See Also:

OrderAdjustment, List

getShippingDiscounts

public java.util.List getShippingDiscounts()

Retrieves a List of OrderAdjustment objects corresponding to shipping adjustments (base shipping and any shipping discounts). This value will always be populated with at least the base shipping cost.

Returns:

a List of OrderAdjustment objects.

See Also:

OrderAdjustment, List

getQuote

public Quote getQuote()

Returns the Quote object for the pricing operation. Available after calling computeTotal() on the PriceService. Null will be returned otherwise.

Returns:

the Quote object associated with the pricing operation if the computeTotal() call was made, otherwise null is returned.

See Also:

PriceService, Quote

getUserDiscounts

public java.util.Set getUserDiscounts()

Returns the Set of QualificationDiscountId objects corresponding to the user discounts applied during the pricing operation.

Returns:

Set of QualificationDiscountId objects or null if no user discounts were applied during the pricing operation.

See Also:

QualificationDiscountId, QualificationDiscountDef

getGlobalDiscounts

public java.util.Set getGlobalDiscounts()

Returns the Set of QualificationDiscountId objects corresponding to the global discounts applied during the pricing operation.

Returns:

Set of QualificationDiscountId objects or null if no global discounts were applied during the pricing operation.

See Also:

QualificationDiscountId, QualificationDiscountDef