atg.commerce.pricing
Class TaxPricingEngineImpl

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.pricing.PricingEngineService
              atg.commerce.pricing.TaxPricingEngineImpl

All Implemented Interfaces:

PricingEngine, TaxPricingEngine, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, Schedulable, java.util.EventListener

public class TaxPricingEngineImpl
extends PricingEngineService
implements TaxPricingEngine

A TaxPricingEngine implementation which computes the tax for an order. It accomplishes this task by invoking a series of TaxPricingCalculators which incrementally compute the tax price:

• The first step is to allow the preCalculators to manipulate the tax price. They are invoked in the order in which they appear in the preCalculators list.
• The second step is to extract the calculators from any input PricingModels, and invoke them in the order in which they appear in the pPricingModels list. It's also at this stage that promotions are filtered based on stacking rules. Stacking rule logic will only be invoked if the pExtraParameters parameter is not null (in order for stacking rule tracking information to be added and used by other pricing engines).
• The last step is to invoke the postCalculators in the order in which they appear in the postCalculators list.

Note: if a particular order of calculator invocation is desired, sorting must be done prior to passing discounts/precalculators/postcalculators in to the Engine.

Properties:

• licenseFileNames is the names of the license components which enable this service.
• preCalculators is a list of ShippingPricingCalculators which are run before any input discounts are applied.
• postCalculators is a list of ShippingPricingCalculators which are run after any input discounts are applied.

See Also:

TaxPricingCalculator, TaxPriceInfo

Nested Class Summary

Nested classes/interfaces inherited from class atg.commerce.pricing.PricingEngineService

PricingEngineService.EmptyItemPriceInfo

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.commerce.pricing.PricingEngineService

EXTRA_PARAM_QUALIFIERSERVICE, mGlobalPromotions, mPricingCalculatorServices

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

TaxPricingEngineImpl()

Method Summary

protected void	applyCalculator(java.lang.Object pCalc, TaxPriceInfo pTaxPriceQuote, PricingContext pPricingContext, java.util.Map pExtraParameters) Calls the supplied calculator service to price an Order for tax.
protected java.util.Collection<RepositoryItem>	applyPromotions(java.util.Collection pPricingModels, TaxPriceInfo pTaxPriceQuote, PricingContext pPricingContext, java.util.Map pExtraParameters) Apply the pricing models (promotions) to the Order being priced for tax.
void	checkPromotionsForCloseness(TaxPriceInfo pPriceInfo, Order pOrder, java.util.Collection pPricingModels, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Check to see if the order qualifies under any of the pricingModels' "closenessQualifiers".
protected boolean	didPromotionQualify(RepositoryItem pPricingModel, PricingContext pPricingContext, java.util.Map pExtraParameters) Determines if a promotion qualified or not.
protected java.lang.String	getCurrencyCode(Order pOrder, java.util.Collection pPricingModels, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Return the currency code that should be used in the context of this pricing request
TaxPricingCalculator[]	getPostCalculators() Gets the PricingCalculators which are run after any discounts are applied
TaxPricingCalculator[]	getPreCalculators() Gets the PricingCalculators which are run before any discounts are applied
atg.commerce.pricing.PromotionProcessingComponent[]	getPrePromotionProcessing() Returns property PrePromotionProcessing
protected java.util.List<AmountInfo>	getPriceInfoDetails(PricingContext pPricingContext, java.util.Map pExtraParameters) Returns price info details for each item.
java.util.Collection	getPricingModels(RepositoryItem pProfile) Returns a List of pricing models (e.g.
protected java.lang.String	getStackingRuleOrderLimitReachedMessageIdentifier() Value for stacking rule order limit reached message identifier.
protected java.lang.String	getStackingRulePromotionExcludedMessageIdentifier() Value for stacking rule promotion excluded message identifier.
TaxPriceInfo	priceTax(Order pOrder, java.util.Collection pPricingModels, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Tax an order within a context.
void	setPostCalculators(TaxPricingCalculator[] pPostCalculators) Sets the PricingCalculators which are run after any discounts are applied
void	setPreCalculators(TaxPricingCalculator[] pPreCalculators) Sets the PricingCalculators which are run before any discounts are applied
void	setPrePromotionProcessing(atg.commerce.pricing.PromotionProcessingComponent[] pPrePromotionProcessing) Sets property PrePromotionProcessing

Methods inherited from class atg.commerce.pricing.PricingEngineService

addPromotion, addPromotionToList, applyPromotionProcessing, checkAndAddPromotions, checkAndMergePromotions, checkPromotionExpiration, createEmptyItemPriceInfo, createPriceInfo, createStackingRuleExclusionMessage, didPromotionApply, doStartService, doStopService, expirePromotion, findGlobalPromotions, generateStackingRuleInfo, getAdjustmentPricingModels, getAlwaysLoadGlobalPromotions, getAppliedPromotions, getCalculator, getCalculatorForCalculatorType, getCalculatorTypeCalculators, getCalculatorTypes, getClosenessQualifierEvaluator, getCurrencyCode, getDefaultLocale, getGlobalPromotions, getGlobalPromotionsQuery, getGlobalPromotionsSchedulableDate, getInitialPromotions, getLocale, getPriceInfoClass, getPricingCurrencyCode, getPricingModelComparator, getPricingModelEvaluationVetoers, getPricingModelHolderVetoers, getPricingModelProperties, getPricingTools, getProfileProperties, getPromotionItemDescriptors, getPromotionItemTypes, getPromotions, getPromotionsRepository, getPromotionTools, getQualifierService, getQualifierService, getQualifierService, getScheduler, getUpdateSchedule, getUserOnlyPromotions, isUseMerge, isValidItemDescriptor, loadGlobalPromotions, performScheduledTask, prepareEvaluationVetoers, prepareHolderVetoers, pricingComplete, removeExpiredPromotions, resetEmptyItemPriceInfos, resolveCalculator, setAlwaysLoadGlobalPromotions, setCalculatorTypeCalculators, setClosenessQualifierEvaluator, setDefaultLocale, setGlobalPromotionsQuery, setGlobalPromotionsSchedulableDate, setPriceInfoClass, setPricingModelComparator, setPricingModelEvaluationVetoers, setPricingModelHolderVetoers, setPricingModelProperties, setPricingTools, setProfileProperties, setPromotionItemTypes, setPromotionsRepository, setPromotionTools, setQualifierService, setScheduler, setUpdateSchedule, setupStackingRuleCollections, setUseMerge, skipPromotion, updateStackingRuleTracking, vetoPromotionsForEvaluation, wasPromotionSkipped

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

TaxPricingEngineImpl

public TaxPricingEngineImpl()

Method Detail

setPreCalculators

public void setPreCalculators(TaxPricingCalculator[] pPreCalculators)

Sets the PricingCalculators which are run before any discounts are applied

getPreCalculators

public TaxPricingCalculator[] getPreCalculators()

Gets the PricingCalculators which are run before any discounts are applied

setPrePromotionProcessing

public void setPrePromotionProcessing(atg.commerce.pricing.PromotionProcessingComponent[] pPrePromotionProcessing)

Sets property PrePromotionProcessing

getPrePromotionProcessing

public atg.commerce.pricing.PromotionProcessingComponent[] getPrePromotionProcessing()

Returns property PrePromotionProcessing

setPostCalculators

public void setPostCalculators(TaxPricingCalculator[] pPostCalculators)

Sets the PricingCalculators which are run after any discounts are applied

getPostCalculators

public TaxPricingCalculator[] getPostCalculators()

Gets the PricingCalculators which are run after any discounts are applied

getPricingModels

public java.util.Collection getPricingModels(RepositoryItem pProfile)

Returns a List of pricing models (e.g. promotions) for a given Profile.

Specified by:

getPricingModels in interface PricingEngine

Parameters:

pProfile - The user's profile from which the engine will extract promotions

Returns:

List of RepositoryItems which represent pricing models for use in pricing.

getCurrencyCode

protected java.lang.String getCurrencyCode(Order pOrder,
                                           java.util.Collection pPricingModels,
                                           java.util.Locale pLocale,
                                           RepositoryItem pProfile,
                                           java.util.Map pExtraParameters)
                                    throws PricingException

Return the currency code that should be used in the context of this pricing request

Throws:

PricingException - if an error occurs while attempting to determine the currency code

priceTax

public 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. The context is represented by the input parameters.

Specified by:

priceTax in interface TaxPricingEngine

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. Return null if no pricing info can be determined. This may occur if the order supplied is null.

Throws:

PricingException - if an error occurs while attempting to price

applyPromotions

protected java.util.Collection<RepositoryItem> applyPromotions(java.util.Collection pPricingModels,
                                                               TaxPriceInfo pTaxPriceQuote,
                                                               PricingContext pPricingContext,
                                                               java.util.Map pExtraParameters)
                                                        throws PricingException

Apply the pricing models (promotions) to the Order being priced for tax. Evaluates the promotions and calls the associated calculator services to price the Order.

Parameters:

pPricingModels - Collection of PricingModel items

pTaxPriceQuote - TaxPriceInfo for the Object being priced

pPricingContext - PricingContext

pExtraParameters - Map of extra parameters, may be null

Returns:

Collection of RepositoryItem promotions that were applied, i.e. weren't vetoed

Throws:

PricingException

applyCalculator

protected void applyCalculator(java.lang.Object pCalc,
                               TaxPriceInfo pTaxPriceQuote,
                               PricingContext pPricingContext,
                               java.util.Map pExtraParameters)
                        throws PricingException

Calls the supplied calculator service to price an Order for tax.

Parameters:

pCalc - OrderPricingCalculator to call

pTaxPriceQuote - TaxPriceInfo for the Order

pPricingContext - PricingContext

pExtraParameters - Map of extra parameters

Throws:

PricingException

checkPromotionsForCloseness

public void checkPromotionsForCloseness(TaxPriceInfo pPriceInfo,
                                        Order pOrder,
                                        java.util.Collection pPricingModels,
                                        java.util.Locale pLocale,
                                        RepositoryItem pProfile,
                                        java.util.Map pExtraParameters)
                                 throws PricingException

Check to see if the order qualifies under any of the pricingModels' "closenessQualifiers". If so, add the closenessQualifiers to the priceInfo.

Parameters:

pPriceInfo - The TaxPriceInfo object associated with the order.

pOrder - The order to check

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

Throws:

PricingException

didPromotionQualify

protected boolean didPromotionQualify(RepositoryItem pPricingModel,
                                      PricingContext pPricingContext,
                                      java.util.Map pExtraParameters)
                               throws PricingException

Determines if a promotion qualified or not. Returns true if the promotion qualified, false otherwise.

Overrides:

didPromotionQualify in class PricingEngineService

Parameters:

pPricingModel - promotion to check

pPricingContext - PricingContext

pExtraParameters - Map of extra parameters, may be null

Returns:

true if the promotion qualified, false otherwise

Throws:

PricingException - if something went wrong

getPriceInfoDetails

protected java.util.List<AmountInfo> getPriceInfoDetails(PricingContext pPricingContext,
                                                         java.util.Map pExtraParameters)

Returns price info details for each item.

Overrides:

getPriceInfoDetails in class PricingEngineService

Parameters:

pPricingContext - PricingContext

pExtraParameters - Map of extra parameters, may be null

Returns:

true if the promotion qualified, false otherwise

getStackingRuleOrderLimitReachedMessageIdentifier

protected java.lang.String getStackingRuleOrderLimitReachedMessageIdentifier()

Value for stacking rule order limit reached message identifier.

Overrides:

getStackingRuleOrderLimitReachedMessageIdentifier in class PricingEngineService

Returns:

message identifier

getStackingRulePromotionExcludedMessageIdentifier

protected java.lang.String getStackingRulePromotionExcludedMessageIdentifier()

Value for stacking rule promotion excluded message identifier.

Overrides:

getStackingRulePromotionExcludedMessageIdentifier in class PricingEngineService

Returns:

message identifier