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

All Superinterfaces:

Serializable

All Known Implementing Classes:

PricingRequestImpl

public interface PricingRequest

extends Serializable

This class is used as input to the computeSubtotal() and computeTotal() operations of the PriceService. PricingRequest attributes allow the request to be customized without changing the interface. This interface is not intended for concurrent use and may produce unpredicatable results if used concurrently.

See Also:

PriceService, PricingRequestImpl, PricingReply, CustomerPk, Line, Money

Method Summary

Serializable	getAttribute(String name) Retrieves the value of a request attribute by name.
Money	getBaseShipping() Retreives the base shipping cost for the request.
CustomerPk	getCustomerPK() Retrieves the CustomerPk associated with this request.
Calendar	getEffectiveDate() The effective date is the date which the Price Service will use to determine whether a given discount is in effect.
Line[]	getLines() Retrieves the Line items for this pricing operation.

Method Detail

getAttribute

public Serializable getAttribute(String name)

Retrieves the value of a request 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 PricingRequest without modifying the interface.

Parameters:

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

Returns:

the value for the named request attribute.

See Also:

Map

getBaseShipping

public Money getBaseShipping()

Retreives the base shipping cost for the request.

Returns:

com.beasys.commerce.axiom.units.Money corresponding to the base shipping cost.

See Also:

Money

getCustomerPK

public CustomerPk getCustomerPK()

Retrieves the CustomerPk associated with this request. A null value indicates an anonymous customer.

Returns:

a CustomerPk object.

See Also:

CustomerPk

getEffectiveDate

public Calendar getEffectiveDate()

The effective date is the date which the Price Service will use to determine whether a given discount is in effect. more precisely if effective date is >= the discount start date and <= the discount end date the discount will be considered for application during the pricing operation. If this value is not set the Price Service will use the current date as obtained through the JVM.

Returns:

the Calendar object representing the effective date for the pricing operation.

See Also:

Calendar

getLines

public Line[] getLines()

Retrieves the Line items for this pricing operation.

Returns:

an array of Line items.

See Also:

Line