atg.commerce.pricing

Class ConfigurableItemPriceCalculator

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.pricing.ItemPriceCalculator

atg.commerce.pricing.ConfigurableItemPriceCalculator

All Implemented Interfaces:

ItemPriceSourceHandler, ItemPricingCalculator, atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class ConfigurableItemPriceCalculator
extends ItemPriceCalculator

A calculator which calculates the list price of a configurable item and sets the itemPriceInfo to be that amount. This will set the list price with the prices of the subskus that the configurable item is configured with. If the configurable item is on sale then the sale price will also be modified.

See Also:

ItemPriceInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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

Constructors

Constructor and Description
ConfigurableItemPriceCalculator()

Method Summary

Modifier and Type	Method and Description
void	clearConfigItemSubSkuMap() Clear the configItemSubSkuMap.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
java.util.Map	getConfigItemSubSkuMap() Returns property configItemSubSkuMap
java.lang.String	getConfigurablePropertiesPropertyName() Returns property ConfigurablePropertiesPropertyName
java.lang.String	getConfigurationOptionItemType() Returns the item type for configurationOption catalog items
java.lang.String	getConfigurationOptionSkuPropertyName() Returns property ConfigurationOptionSkuPropertyName
java.lang.String	getConfigurationOptionsPricePropertyName() Returns property configurationOptionsPricePropertyName
java.lang.String	getConfigurationOptionsPropertyName() Returns property ConfigurationOptionsPropertyName
java.lang.String	getOnSalePropertyName() Returns property OnSalePropertyName
PricingTools	getPricingTools() pricing tools to help with price calculation
protected double	getSalePrice(java.lang.Object pPriceSource)
java.lang.String	getSalePricePropertyName() Returns property salePricePropertyName
long	getSubSkuQuantity(CommerceItem pSubItem) Get the quantity for the given subsku.
double	getSubSkuQuantityDerivedAsFloatingPoint(CommerceItem pSubItem) Get the quantity for the given subsku.
double	getSubSkuQuantityWithFraction(CommerceItem pSubItem) Get the quantity (with fraction) for the given subsku.
protected boolean	onSale(java.lang.Object pPriceSource) Returns true if the commerce item to be priced is on sale
protected void	priceItem(double pPrice, ItemPriceInfo pPriceQuote, CommerceItem pItem, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Sets the list price or sale price of the head of a configurable item tree with the given price in addition to the sum of the sub sku prices.
protected void	priceItem(double pPrice, ItemPriceInfo pPriceQuote, ConfigurableCommerceItem pItem, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters, boolean pOnSale) Sets the list price or sale price of any configurable item within a tree with the given price in addition to the sum of its sub sku prices.
void	priceItem(ItemPriceInfo pPriceQuote, CommerceItem pItem, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Price a single item in a context
void	setConfigurablePropertiesPropertyName(java.lang.String pConfigurablePropertiesPropertyName) Sets property ConfigurablePropertiesPropertyName
void	setConfigurationOptionItemType(java.lang.String pConfigurationOptionItemType) Sets the item type for configurationOption catalog items
void	setConfigurationOptionSkuPropertyName(java.lang.String pConfigurationOptionSkuPropertyName) Sets property ConfigurationOptionSkuPropertyName
void	setConfigurationOptionsPricePropertyName(java.lang.String pConfigurationOptionsPricePropertyName) Sets property configurationOptionsPricePropertyName
void	setConfigurationOptionsPropertyName(java.lang.String pConfigurationOptionsPropertyName) Sets property ConfigurationOptionsPropertyName
void	setOnSalePropertyName(java.lang.String pOnSalePropertyName) Sets property OnSalePropertyName
void	setPricingTools(PricingTools pPricingTools) pricing tools to help with price calculation
void	setSalePricePropertyName(java.lang.String pSalePricePropertyName) Sets property salePricePropertyName

Methods inherited from class atg.commerce.pricing.ItemPriceCalculator

getItemPriceSource, getLoggingIdentifier, getPrice, getPricePropertyName, getPriceSource, getPriceSource, isPriceFromCatalogRef, isRequirePriceValue, populateItemPriceSource, priceEachItem, priceItems, setLoggingIdentifier, setPriceFromCatalogRef, setPricePropertyName, setRequirePriceValue, shouldConsumeSource

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, 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, toString

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ConfigurableItemPriceCalculator

public ConfigurableItemPriceCalculator()

Method Detail

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

pricing tools to help with price calculation

Overrides:

setPricingTools in class ItemPriceCalculator

Parameters:

pPricingTools - new value to set

getPricingTools

public PricingTools getPricingTools()

pricing tools to help with price calculation

Overrides:

getPricingTools in class ItemPriceCalculator

Returns:

property PricingTools

getSalePricePropertyName

public java.lang.String getSalePricePropertyName()

Returns property salePricePropertyName

Returns:

returns property salePricePropertyName

setSalePricePropertyName

public void setSalePricePropertyName(java.lang.String pSalePricePropertyName)

Sets property salePricePropertyName

Parameters:

pSalePricePropertyName - the value to set for property salePricePropertyName

setOnSalePropertyName

public void setOnSalePropertyName(java.lang.String pOnSalePropertyName)

Sets property OnSalePropertyName

getOnSalePropertyName

public java.lang.String getOnSalePropertyName()

Returns property OnSalePropertyName

getConfigurationOptionsPricePropertyName

public java.lang.String getConfigurationOptionsPricePropertyName()

Returns property configurationOptionsPricePropertyName

Returns:

returns property configurationOptionsPricePropertyName

setConfigurationOptionsPricePropertyName

public void setConfigurationOptionsPricePropertyName(java.lang.String pConfigurationOptionsPricePropertyName)

Sets property configurationOptionsPricePropertyName

Parameters:

pConfigurationOptionsPricePropertyName - the value to set for property configurationOptionsPricePropertyName

getConfigurablePropertiesPropertyName

public java.lang.String getConfigurablePropertiesPropertyName()

Returns property ConfigurablePropertiesPropertyName

Returns:

returns property ConfigurablePropertiesPropertyName

setConfigurablePropertiesPropertyName

public void setConfigurablePropertiesPropertyName(java.lang.String pConfigurablePropertiesPropertyName)

Sets property ConfigurablePropertiesPropertyName

Parameters:

pConfigurablePropertiesPropertyName - the value to set for property ConfigurablePropertiesPropertyName

getConfigurationOptionsPropertyName

public java.lang.String getConfigurationOptionsPropertyName()

Returns property ConfigurationOptionsPropertyName

Returns:

returns property ConfigurationOptionsPropertyName

setConfigurationOptionsPropertyName

public void setConfigurationOptionsPropertyName(java.lang.String pConfigurationOptionsPropertyName)

Sets property ConfigurationOptionsPropertyName

Parameters:

pConfigurationOptionsPropertyName - the value to set for property ConfigurationOptionsPropertyName

getConfigurationOptionSkuPropertyName

public java.lang.String getConfigurationOptionSkuPropertyName()

Returns property ConfigurationOptionSkuPropertyName

Returns:

returns property ConfigurationOptionSkuPropertyName

setConfigurationOptionSkuPropertyName

public void setConfigurationOptionSkuPropertyName(java.lang.String pConfigurationOptionSkuPropertyName)

Sets property ConfigurationOptionSkuPropertyName

Parameters:

pConfigurationOptionSkuPropertyName - the value to set for property ConfigurationOptionSkuPropertyName

getConfigurationOptionItemType

public java.lang.String getConfigurationOptionItemType()

Returns the item type for configurationOption catalog items

Returns:

returns property ConfigurationOptionItemType

setConfigurationOptionItemType

public void setConfigurationOptionItemType(java.lang.String pConfigurationOptionItemType)

Sets the item type for configurationOption catalog items

Parameters:

pConfigurationOptionItemType - the value to set for property ConfigurationOptionItemType

getConfigItemSubSkuMap

public java.util.Map getConfigItemSubSkuMap()

Returns property configItemSubSkuMap

Returns:

returns property configItemSubSkuMap

clearConfigItemSubSkuMap

public void clearConfigItemSubSkuMap()

Clear the configItemSubSkuMap.

getSalePrice

protected double getSalePrice(java.lang.Object pPriceSource)
                       throws PricingException

Throws:

PricingException

priceItem

public void priceItem(ItemPriceInfo pPriceQuote,
                      CommerceItem pItem,
                      RepositoryItem pPricingModel,
                      java.util.Locale pLocale,
                      RepositoryItem pProfile,
                      java.util.Map pExtraParameters)
               throws PricingException

Price a single item in a context

Specified by:

priceItem in interface ItemPricingCalculator

Overrides:

priceItem in class ItemPriceCalculator

Parameters:

pPriceQuote - ItemPriceInfo representing the current price quote for the item

pItem - The item to price

pPricingModel - A RepositoryItem representing a PricingModel

pProfile - The user's profile

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

Throws:

PricingException

See Also:

ItemPriceCalculator.getPriceSource(ItemPriceInfo, CommerceItem, RepositoryItem, Locale, RepositoryItem, Map)

priceItem

protected void priceItem(double pPrice,
                         ItemPriceInfo pPriceQuote,
                         CommerceItem pItem,
                         RepositoryItem pPricingModel,
                         java.util.Locale pLocale,
                         RepositoryItem pProfile,
                         java.util.Map pExtraParameters)
                  throws PricingException

Sets the list price or sale price of the head of a configurable item tree with the given price in addition to the sum of the sub sku prices.

Each subitem contributes a PricingAdjustment to the parent item's ItemPriceInfo and to all of its DetailedItemPriceInfos. The subitem also gets its own ItemPriceInfo, a DetailedItemPriceInfo, and a single PricingAdjustment on each. All of the PricingAdjustments contain the same information.

Specified by:

priceItem in class ItemPriceCalculator

Parameters:

pPrice - the price as extracted from the item

pPriceQuote - ItemPriceInfo representing the current price quote for the item

pItem - The item to price

pPricingModel - A RepositoryItem representing a PricingModel

pLocale - the locale in which this item should be priced

pProfile - The user's profile

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

Throws:

PricingException - if there was a problem pricing the input pItem

priceItem

protected void priceItem(double pPrice,
                         ItemPriceInfo pPriceQuote,
                         ConfigurableCommerceItem pItem,
                         RepositoryItem pPricingModel,
                         java.util.Locale pLocale,
                         RepositoryItem pProfile,
                         java.util.Map pExtraParameters,
                         boolean pOnSale)
                  throws PricingException

Sets the list price or sale price of any configurable item within a tree with the given price in addition to the sum of its sub sku prices. This method calls itself recursively for any sub sku that is also configurable.

Each subitem contributes a PricingAdjustment to the parent item's ItemPriceInfo and to all of its DetailedItemPriceInfos. The subitem also gets its own ItemPriceInfo, a DetailedItemPriceInfo, and a single PricingAdjustment on each. All of the PricingAdjustments contain the same information.

Parameters:

pPrice - the item's list or sale price, as appropriate for the item's price source (a sku or configurationOption)

pPriceQuote - ItemPriceInfo representing the current price quote for the item. If the item is on sale, pPriceQuote.listPrice must already be filled in with the item's base price (without sub skus).

pItem - The parent item to price

pPricingModel - A RepositoryItem representing a PricingModel

pLocale - the locale in which this item should be priced

pProfile - The user's profile

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

pOnSale - true if pPrice is a sale price

Throws:

PricingException - if there was a problem pricing the input pItem

onSale

protected boolean onSale(java.lang.Object pPriceSource)
                  throws PricingException

Returns true if the commerce item to be priced is on sale

Throws:

PricingException

getSubSkuQuantity

public long getSubSkuQuantity(CommerceItem pSubItem)

Get the quantity for the given subsku.

Parameters:

pSubItem - The CommerceItem object for the sub sku

Returns:

The subitem quantity

getSubSkuQuantityWithFraction

public double getSubSkuQuantityWithFraction(CommerceItem pSubItem)

Get the quantity (with fraction) for the given subsku.

Parameters:

pSubItem - The CommerceItem object for the sub sku

Returns:

The subitem quantity

getSubSkuQuantityDerivedAsFloatingPoint

public double getSubSkuQuantityDerivedAsFloatingPoint(CommerceItem pSubItem)

Get the quantity for the given subsku.

If the subsku's quantity is fractional, then that value will be returned, otherwise a double representation of the subsku's quantity value.

Parameters:

pSubItem - The CommerceItem object for the sub sku

Returns:

The subitem quantity

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: GenericService

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up