atg.commerce.pricing
Interface TaxPricingEngine

All Superinterfaces:

PricingEngine

All Known Implementing Classes:

TaxPricingEngineImpl

public interface TaxPricingEngine
extends PricingEngine

This extension of the PricingEngine interface describes an object whose job it is to determine prices for ShippingGroup objects. Implementations of this interface are asked to determine the price for the tax associated with an input Order object. The interface is very simple. There's exactly one way to ask for a tax price. Calling code provides the pricing context by inputting the Order, any pricing models (promotions), a locale in which the pricing should occur, the current profile, and any extra parameters that they feel might be necessary. Be aware, though, that the extra parameters are ignored in all DCS implementations of this interface.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

TaxPriceInfo

priceTax(Order pOrder, java.util.Collection pPricingModels, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Tax an order within a context

Methods inherited from interface atg.commerce.pricing.PricingEngine

getPricingModels

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

priceTax

TaxPriceInfo priceTax(Order pOrder,
                      java.util.Collection pPricingModels,
                      java.util.Locale pLocale,
                      RepositoryItem pProfile,
                      java.util.Map pExtraParameters)
                      throws PricingException

Tax an order within a context

Parameters:

pOrder - The order to tax

pPricingModels - A Collection of RepositoryItems representing PricingModels

pLocale - The Locale to use for pricing

pProfile - The user's profile

pExtraParameters - A Map of extra parameters to be used in the pricing, may be null

Returns:

TaxPriceInfo representing the tax quote for the order

Throws:

PricingException