atg.commerce.pricing
Class PricingEngineService

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ItemPricingEngineImpl, OrderPricingEngineImpl, ShippingPricingEngineImpl, TaxPricingEngineImpl

public abstract class PricingEngineService
extends GenericService
implements Schedulable

A GenericService version of a PricingEngine. PricingEngine implementations can extend this class in order to leverage scheduling, global promotions, locale, and other configuration functionality from the PricingEngineService.

Properties:

• scheduler is the atg.service.scheduler.Scheduler which this service uses to periodically run the globalPromotionsQuery. Re-running that query generates a new list of global promotions.
• updateSchedule is the schedule on which the globalPromotionsQuery is periodically run.
• defaultLocale is the default locale in which this pricing engine should generate prices.
• priceInfoClass is the class of the prices that this engine generates.
• pricingModelComparator is the comparator that's used to sort pricing models.
• pricingModelProperties is a bean that holds the name of every property of a pricing model RepositoryItem.
• profileProperties is a list of properties of a profile that should be checked for active promotions.
• promotionsRepository is the repository that holds all of the promotions which this engine can use as pricing models.
• promotionItemTypes is an array of item descriptor names in the promotionsRepository. A promotion that this engine uses as a pricing model must be of one of the types in promotionItemTypes.
• globalPromotionsQuery is a query that is run on the promotionsRepository to return all promotions which should always be taken into account in every pricing. A typical way to mark global promotions is to have all promotions in the promotionsRepository have a boolean property 'global', and to have the query return all promotions whose 'global' property is 'true'.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.util.List	mGlobalPromotions

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

PricingEngineService()

Method Summary

protected boolean	addPromotion(RepositoryItem pPromotion, java.util.Date pNow) This method determines if the given promotion should qualify for use in determing pricing.
void	addPromotionToList(RepositoryItem pPromotion, java.util.List pPricingModels, RepositoryItem pProfile) Adds a new promotion to the list of pricing models.
protected void	checkAndAddPromotions(java.util.Collection pSource, java.util.Collection pDestination, java.util.Date pNow, RepositoryItem pProfile) Receives a collection of promotionStatus objects which are cycled through to determine which of these promotions has expired, and which should be added to the pricingModels used.
protected boolean	checkPromotionExpiration(RepositoryItem pPromotion, java.util.Date pNow) Return true if the promotion has expired and should be removed from the user's collection of active promotions
protected AmountInfo	createPriceInfo() Returns a new instance of the of the class defined through the priceInfoClass property.
void	doStartService() Loads the global promotions.
void	doStopService() Stops the schedule for updating the global promotions
protected void	expirePromotion(RepositoryItem pPromotion, RepositoryItem pProfile) Called if checkPromotionExpiration determines that a promotion has expired and should no longer be active.
protected java.util.List	findGlobalPromotions() Return the set of global promotions for this pricing engine
protected java.util.List	getAdjustmentPricingModels(AmountInfo pPriceInfo) Gets the pricingModels from the priceInfo's "adjustments" property These are the promotions the order has qualified for, and should not be evaluated for closeness
protected java.lang.Object	getCalculator(RepositoryItem pPricingModel) Return the pricing calculator that should be used for the given promotion.
ClosenessQualifierEvaluator	getClosenessQualifierEvaluator()
protected java.lang.String	getCurrencyCode(java.util.Locale pLocale) Return the currency code which should be used for the given locale.
java.util.Locale	getDefaultLocale() Returns property DefaultLocale
java.util.List	getGlobalPromotions() Returns property GlobalPromotions
RqlStatement	getGlobalPromotionsQuery() Returns property GlobalPromotionsQuery
CurrentDate	getGlobalPromotionsSchedulableDate() Returns property GlobalPromotionsSchedulableDate
protected java.util.List	getInitialPromotions(RepositoryItem pProfile) Helper method that returns a List of promotions for given a Profile.
java.lang.Class	getPriceInfoClass() Returns property PriceInfoClass
java.util.Comparator	getPricingModelComparator() Returns property PricingModelComparator
PricingModelProperties	getPricingModelProperties() Returns a bean that contains properties for a PricingModel
java.lang.String[]	getProfileProperties() The profile properties to inspect for pricing models
RepositoryItemDescriptor[]	getPromotionItemDescriptors() Returns the promotion item descriptors
java.lang.String[]	getPromotionItemTypes() Returns property PromotionItemTypes
java.util.List	getPromotions(RepositoryItem pProfile)
Repository	getPromotionsRepository() The repository which contains the promotions
PromotionTools	getPromotionTools() Returns property PromotionTools
Scheduler	getScheduler() Returns property Scheduler
Schedule	getUpdateSchedule() Returns property UpdateSchedule
java.util.List	getUserOnlyPromotions(RepositoryItem pProfile)
void	loadGlobalPromotions() Find and load the global promotions.
void	performScheduledTask(Scheduler pScheduler, ScheduledJob pJob) Reload the global promotions
void	setClosenessQualifierEvaluator(ClosenessQualifierEvaluator pClosenessQualifierEvaluator) Component that evaluates if an order or item meets the closenessQualifiers for relevant promotions
void	setDefaultLocale(java.util.Locale pDefaultLocale) Sets property DefaultLocale
void	setGlobalPromotionsQuery(RqlStatement pGlobalPromotionsQuery) Sets property GlobalPromotionsQuery
void	setGlobalPromotionsSchedulableDate(CurrentDate pGlobalPromotionsSchedulableDate) Sets property GlobalPromotionsSchedulableDate
void	setPriceInfoClass(java.lang.Class pPriceInfoClass) Sets property PriceInfoClass
void	setPricingModelComparator(java.util.Comparator pPricingModelComparator) Sets property PricingModelComparator
void	setPricingModelProperties(PricingModelProperties pPricingModelProperties)
void	setProfileProperties(java.lang.String[] pProfileProperties)
void	setPromotionItemTypes(java.lang.String[] pPromotionItemTypes) Sets property PromotionItemTypes
void	setPromotionsRepository(Repository pPromotionsRepository)
void	setPromotionTools(PromotionTools pPromotionTools) Sets property PromotionTools
void	setScheduler(Scheduler pScheduler) Sets property Scheduler
void	setUpdateSchedule(Schedule pUpdateSchedule) Sets property UpdateSchedule

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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

mGlobalPromotions

protected java.util.List mGlobalPromotions

Constructor Detail

PricingEngineService

public PricingEngineService()

Method Detail

getPromotionItemDescriptors

public RepositoryItemDescriptor[] getPromotionItemDescriptors()

Returns the promotion item descriptors

setPromotionTools

public void setPromotionTools(PromotionTools pPromotionTools)

Sets property PromotionTools

getPromotionTools

public PromotionTools getPromotionTools()

Returns property PromotionTools

setScheduler

public void setScheduler(Scheduler pScheduler)

Sets property Scheduler

getScheduler

public Scheduler getScheduler()

Returns property Scheduler

setUpdateSchedule

public void setUpdateSchedule(Schedule pUpdateSchedule)

Sets property UpdateSchedule

getUpdateSchedule

public Schedule getUpdateSchedule()

Returns property UpdateSchedule

setDefaultLocale

public void setDefaultLocale(java.util.Locale pDefaultLocale)

Sets property DefaultLocale

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns property DefaultLocale

getGlobalPromotions

public java.util.List getGlobalPromotions()

Returns property GlobalPromotions

setPriceInfoClass

public void setPriceInfoClass(java.lang.Class pPriceInfoClass)

Sets property PriceInfoClass

getPriceInfoClass

public java.lang.Class getPriceInfoClass()

Returns property PriceInfoClass

setPricingModelComparator

public void setPricingModelComparator(java.util.Comparator pPricingModelComparator)

Sets property PricingModelComparator

getPricingModelComparator

public java.util.Comparator getPricingModelComparator()

Returns property PricingModelComparator

setClosenessQualifierEvaluator

public void setClosenessQualifierEvaluator(ClosenessQualifierEvaluator pClosenessQualifierEvaluator)

Component that evaluates if an order or item meets the closenessQualifiers for relevant promotions

Parameters:

pClosenessQualifierEvaluator - the component that evaluates if an order or item meets the closenessQualifiers for relevant promotions

getClosenessQualifierEvaluator

public ClosenessQualifierEvaluator getClosenessQualifierEvaluator()

Returns:

the component that evaluates if an order or item meets the closenessQualifiers for relevant promotions

setPricingModelProperties

public void setPricingModelProperties(PricingModelProperties pPricingModelProperties)

getPricingModelProperties

public PricingModelProperties getPricingModelProperties()

Returns a bean that contains properties for a PricingModel

setProfileProperties

public void setProfileProperties(java.lang.String[] pProfileProperties)

getProfileProperties

public java.lang.String[] getProfileProperties()

The profile properties to inspect for pricing models

setPromotionsRepository

public void setPromotionsRepository(Repository pPromotionsRepository)

getPromotionsRepository

public Repository getPromotionsRepository()

The repository which contains the promotions

setPromotionItemTypes

public void setPromotionItemTypes(java.lang.String[] pPromotionItemTypes)

Sets property PromotionItemTypes

getPromotionItemTypes

public java.lang.String[] getPromotionItemTypes()

Returns property PromotionItemTypes

setGlobalPromotionsQuery

public void setGlobalPromotionsQuery(RqlStatement pGlobalPromotionsQuery)

Sets property GlobalPromotionsQuery

getGlobalPromotionsQuery

public RqlStatement getGlobalPromotionsQuery()

Returns property GlobalPromotionsQuery

setGlobalPromotionsSchedulableDate

public void setGlobalPromotionsSchedulableDate(CurrentDate pGlobalPromotionsSchedulableDate)

Sets property GlobalPromotionsSchedulableDate

getGlobalPromotionsSchedulableDate

public CurrentDate getGlobalPromotionsSchedulableDate()

Returns property GlobalPromotionsSchedulableDate

findGlobalPromotions

protected java.util.List findGlobalPromotions()

Return the set of global promotions for this pricing engine

loadGlobalPromotions

public void loadGlobalPromotions()
                          throws PricingException

Find and load the global promotions. The global promotions are found through the method findGlobalPromotions. The list returned by this operation is made available through the globalPromotions property.

Throws:

PricingException

doStartService

public void doStartService()
                    throws ServiceException

Loads the global promotions.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

doStopService

public void doStopService()
                   throws ServiceException

Stops the schedule for updating the global promotions

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if an error occurred during the operation

performScheduledTask

public void performScheduledTask(Scheduler pScheduler,
                                 ScheduledJob pJob)

Reload the global promotions

Specified by:

performScheduledTask in interface Schedulable

Parameters:

pScheduler - calling the job

pJob - the ScheduledJob

getCurrencyCode

protected java.lang.String getCurrencyCode(java.util.Locale pLocale)

Return the currency code which should be used for the given locale. If the supplied locale parameter is null, then use the default locale.

createPriceInfo

protected AmountInfo createPriceInfo()
                              throws PricingException

Returns a new instance of the of the class defined through the priceInfoClass property.

Throws:

PricingException - if there was a problem instantiating the object

getInitialPromotions

protected java.util.List getInitialPromotions(RepositoryItem pProfile)
                                       throws PricingException

Helper method that returns a List of promotions for given a Profile. This is used by the out-of-the-box implementations of the PricingEngine interface for the getPromotions method. Extensions of the various PricingEngines will override the getPromotions method to behave as business requirments dictate.

Parameters:

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

Returns:

List of RepositoryItems which represent promotions for use in pricing. The list which is a combination of the global and user specific promotions.

Throws:

PricingException

addPromotionToList

public void addPromotionToList(RepositoryItem pPromotion,
                               java.util.List pPricingModels,
                               RepositoryItem pProfile)

Adds a new promotion to the list of pricing models.

Parameters:

pPromotion -

pPricingModels -

pProfile -

Throws:

PricingException

See Also:

checkAndAddPromotions(Collection, Collection, Date, RepositoryItem)

getUserOnlyPromotions

public java.util.List getUserOnlyPromotions(RepositoryItem pProfile)
                                     throws PricingException

Throws:

PricingException

getPromotions

public java.util.List getPromotions(RepositoryItem pProfile)
                             throws PricingException

Throws:

PricingException

checkAndAddPromotions

protected void checkAndAddPromotions(java.util.Collection pSource,
                                     java.util.Collection pDestination,
                                     java.util.Date pNow,
                                     RepositoryItem pProfile)

Receives a collection of promotionStatus objects which are cycled through to determine which of these promotions has expired, and which should be added to the pricingModels used.

addPromotion

protected boolean addPromotion(RepositoryItem pPromotion,
                               java.util.Date pNow)

This method determines if the given promotion should qualify for use in determing pricing.

Parameters:

pPromotion - the promotion that should be verified

pNow - the current date

pProfile - the user's profile

Returns:

true if the promotion should be added to the list of promotions which can be used for pricing

checkPromotionExpiration

protected boolean checkPromotionExpiration(RepositoryItem pPromotion,
                                           java.util.Date pNow)

Return true if the promotion has expired and should be removed from the user's collection of active promotions

Parameters:

pPromotion - the promotion that should be verified

pNow - the current date

pProfile - the user's profile

expirePromotion

protected void expirePromotion(RepositoryItem pPromotion,
                               RepositoryItem pProfile)

Called if checkPromotionExpiration determines that a promotion has expired and should no longer be active. Currently this method calls PromotionTools.expirePromotion.

Parameters:

pProfile - the profile for which a promotion has expired

pPromotion - the promotion which has expired

getCalculator

protected java.lang.Object getCalculator(RepositoryItem pPricingModel)
                                  throws PricingException

Return the pricing calculator that should be used for the given promotion. Looks in member variable Map mPricingCalculatorServices for the PricingCalculator refered to by the PricingModel parameter. If the PricingCalculator is not in the Map, it is resolved in Nucleus and then stored in the Map for quick look up.

Parameters:

pPromotion - The promotion to examine for its PricingCalculator

Returns:

The PricingCalculator service found for the promotion

Throws:

PricingException

getAdjustmentPricingModels

protected java.util.List getAdjustmentPricingModels(AmountInfo pPriceInfo)

Gets the pricingModels from the priceInfo's "adjustments" property These are the promotions the order has qualified for, and should not be evaluated for closeness

Parameters:

pPriceInfo - the priceInfo object

Returns:

a List of the pricingModels from the priceInfo's adjustments