PricingReply Interface

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

public interface PricingReply

    extends 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.

Related Topics

PriceService
PricingRequest
Money


All Superinterfaces
Serializable

Method Summary

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

Method Detail

getActualShipping() Method

public Money getActualShipping()
Retrieves the actual shipping cost after discounting.

Related Topics

Money


getAttribute(String) Method

public Serializable getAttribute(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.

Related Topics

Map


getBaseShipping() Method

public Money getBaseShipping()
Retrieves the base shipping cost before discounting.

Related Topics

Money


getGlobalDiscounts() Method

public 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.

Related Topics

QualificationDiscountId
QualificationDiscountDef


getLines() Method

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.

Related Topics

Line


getOrderDiscounts() Method

public 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.

Related Topics

OrderAdjustment
List


getQuote() Method

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.

Related Topics

PriceService
Quote


getShippingDiscounts() Method

public 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.

Related Topics

OrderAdjustment
List


getSubtotal() Method

public Money getSubtotal()
Retrieves the subtotal for the pricing request. More precisely the sum of the Line item costs.

Related Topics

Money


getTotal() Method

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

Related Topics

Money


getUserDiscounts() Method

public 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.

Related Topics

QualificationDiscountId
QualificationDiscountDef