atg.commerce.pricing
Class ItemSalePriceCalculator

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.pricing.ItemPriceCalculator
              atg.commerce.pricing.ItemSalePriceCalculator

All Implemented Interfaces:

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

public class ItemSalePriceCalculator
extends ItemPriceCalculator

A calculator which determines the sale price of an item and discounts the itemPriceInfo to that amount, while at the same time maintaining the audit trail of the ItemPriceInfo. There is no rule associate with this calculator. If one of ItemSalePriceCalculator's pricing methods is invoked, all input items are discounted to the sale price.

Properties:

• onSalePropertyName is the boolean property of the price source that is used to determine if the price source is on sale. (in DCS, a price source is the catalogRef or productRef of a CommerceItem.

See Also:

ItemPriceInfo

Field Summary

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

ItemSalePriceCalculator()

Method Summary

void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
java.lang.String	getOnSalePropertyName() Returns property OnSalePropertyName
protected boolean	onSale(java.lang.Object pPriceSource) Returns true if the commerce item to be priced is on sale
boolean	populateItemPriceSource(ItemPriceSource pItemPriceSource, Order pOrder, CommerceItem pCommerceItem, CommerceItem pParentCommerceItem, java.util.Map pExtraParameters) Populates the sale price property of the source based on the PricingAdjustment added by this calculator and the source's list price value.
protected void	priceItem(double pPrice, ItemPriceInfo pPriceQuote, CommerceItem pItem, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) Sets the sale price with the given determined price
void	priceItem(ItemPriceInfo pPriceQuote, CommerceItem pItem, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, java.util.Map pExtraParameters) If the item should be priced as a sales item (method onSale return true) then go ahead an price it
void	setOnSalePropertyName(java.lang.String pOnSalePropertyName) Sets property OnSalePropertyName
boolean	shouldConsumeSource(ItemPriceSource pItemPriceSource) If the onSale property is false or salePrice property is null, false is returned.

Methods inherited from class atg.commerce.pricing.ItemPriceCalculator

getItemPriceSource, getLoggingIdentifier, getPrice, getPricePropertyName, getPriceSource, getPriceSource, getPricingTools, isPriceFromCatalogRef, isRequirePriceValue, priceEachItem, priceItems, setLoggingIdentifier, setPriceFromCatalogRef, setPricePropertyName, setPricingTools, setRequirePriceValue

Methods inherited from class atg.nucleus.GenericService

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

Constructor Detail

ItemSalePriceCalculator

public ItemSalePriceCalculator()

Method Detail

setOnSalePropertyName

public void setOnSalePropertyName(java.lang.String pOnSalePropertyName)

Sets property OnSalePropertyName

getOnSalePropertyName

public java.lang.String getOnSalePropertyName()

Returns property OnSalePropertyName

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 sale price with the given determined price

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

pProfile - The user's profile

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

Throws:

PricingException

priceItem

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

If the item should be priced as a sales item (method onSale return true) then go ahead an price it

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)

onSale

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

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

Throws:

PricingException

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

populateItemPriceSource

public boolean populateItemPriceSource(ItemPriceSource pItemPriceSource,
                                       Order pOrder,
                                       CommerceItem pCommerceItem,
                                       CommerceItem pParentCommerceItem,
                                       java.util.Map pExtraParameters)

Populates the sale price property of the source based on the PricingAdjustment added by this calculator and the source's list price value.

Specified by:

populateItemPriceSource in interface ItemPriceSourceHandler

Overrides:

populateItemPriceSource in class ItemPriceCalculator

Parameters:

pItemPriceSource - the source being generated and populated with pricing data.

pOrder - the Order

pCommerceItem - the item for which the source is being created

pParentCommerceItem - the item that contained pCommerceItem

pExtraParameters - a Map of extra parameters objects that was passed to the initial call to generate the source objects.

Returns:

true if the sale price value is set.

shouldConsumeSource

public boolean shouldConsumeSource(ItemPriceSource pItemPriceSource)

If the onSale property is false or salePrice property is null, false is returned. Otherwise true.

Specified by:

shouldConsumeSource in interface ItemPriceSourceHandler

Overrides:

shouldConsumeSource in class ItemPriceCalculator

Parameters:

pItemPriceSource - the source that was given to price the item.

Returns:

true if the source should be consumed by the calculator. false if the calculator should bypass its processing and return normally.