atg.commerce.pricing

Class GroupDiscountCalculator

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.pricing.DiscountCalculatorService

atg.commerce.pricing.ItemDiscountCalculator

atg.commerce.pricing.GroupDiscountCalculator

All Implemented Interfaces:

CalculatorInfoProvider, 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 GroupDiscountCalculator
extends ItemDiscountCalculator
implements CalculatorInfoProvider

Calculates Group Discount

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	GROUP_CALCULATOR_TYPE PMDL calculator type

Fields inherited from class atg.commerce.pricing.ItemDiscountCalculator

EXTRA_PARAM_QUALIFIERSERVICE

Fields inherited from class atg.commerce.pricing.DiscountCalculatorService

AMOUNT_INCREASE_TYPE, AMOUNT_OFF_TYPE, FIXED_PRICE_TYPE, ILLEGAL_TYPE, mPromotionTools, PERCENT_OFF_TYPE

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
GroupDiscountCalculator()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.Integer,atg.commerce.pricing.DiscountGroup>	buildGroups(java.util.Collection qualifyingItems) Build a structure which places quantities of qualified detailed item price infos into groups for purposes of discounting.
double	findAdjustedPriceWithinGroup(DetailedItemPriceInfo pDetailedItemPriceInfo, RepositoryItem pPricingModel, java.util.Locale pLocale, double pGroupTotal, java.util.Map pExtraParameters)
CalculatorInfo	getCalculatorInfo() Retrieve information about this calculator.
PricingTools	getPricingTools() pricing tools to help with calculating prices
protected void	handleLeftOvers(java.util.List<DetailedItemPriceInfo> pDetails, double pLeftOvers) This method deals with the case where precision may be lost when applying discount to multiple items due to rounding.
protected void	handleLeftOvers(java.util.List<DetailedItemPriceInfo> pDetails, double pLeftOvers, java.lang.String pCurrencyCode) This method deals with the case where precision may be lost when applying discount to multiple items due to rounding.
protected void	priceGroup(atg.commerce.pricing.DiscountGroup pDiscountGroup, RepositoryItem pPricingModel, java.util.Locale pLocale, double pGroupTotal, java.util.Map pExtraParameters) Re-prices dipis within a group according to the pricing model passed in.
void	priceItems(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, java.util.Locale pLocale, RepositoryItem pProfile, Order pOrder, java.util.Map pExtraParameters) Price a List of items together in a context when it comes right down to it, we're only discounting single items : the only reason we need to price items in a context is to allow complex qualification statements.
void	setPricingTools(PricingTools pPricingTools) pricing tools to help with calculating prices
protected void	updateQualifiedItems(java.util.Collection pQualifiedItems, java.util.Map pExtraParameters) Update a qualified item to reflect any re-pricing operations carried out on its associated dipis.

Methods inherited from class atg.commerce.pricing.ItemDiscountCalculator

determineDiscountNumber, determineDiscountNumberWithFraction, doStartService, findAdjustedPrice, findQualifyingItems, getAmountToDiscount, getRangeComparator, priceDetailedItemPriceInfo, priceEachItem, priceItem, priceQualifyingItem, priceQualifyingItems, setRangeComparator, updateDetailedPriceInfos, updateQualifyingDetails, updateQuantityAsQualifier, validateQualifierService

Methods inherited from class atg.commerce.pricing.DiscountCalculatorService

adjust, adjustAmount, adjustAmount, getAdjuster, getDiscountType, getDiscountType, getPricingModelProperties, getPromotionTools, getQualifierService, getQualifierService, isNegativeAmountException, setNegativeAmountException, setPricingModelProperties, setPromotionTools, setQualifierService

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

GROUP_CALCULATOR_TYPE

public static final java.lang.String GROUP_CALCULATOR_TYPE

PMDL calculator type

See Also:

Constant Field Values

Constructor Detail

GroupDiscountCalculator

public GroupDiscountCalculator()

Method Detail

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

pricing tools to help with calculating prices

Overrides:

setPricingTools in class ItemDiscountCalculator

Parameters:

pPricingTools - new value to set

getPricingTools

public PricingTools getPricingTools()

pricing tools to help with calculating prices

Overrides:

getPricingTools in class ItemDiscountCalculator

Returns:

property PricingTools

priceItems

public void priceItems(java.util.List pPriceQuotes,
                       java.util.List pItems,
                       RepositoryItem pPricingModel,
                       java.util.Locale pLocale,
                       RepositoryItem pProfile,
                       Order pOrder,
                       java.util.Map pExtraParameters)
                throws PricingException

Description copied from class: ItemDiscountCalculator

Price a List of items together in a context when it comes right down to it, we're only discounting single items : the only reason we need to price items in a context is to allow complex qualification statements.

Specified by:

priceItems in interface ItemPricingCalculator

Overrides:

priceItems in class ItemDiscountCalculator

Parameters:

pPriceQuotes - List of ItemPriceInfo objects representing the current price quotes for the items

pItems - The items to price

pPricingModel - A RepositoryItem representing a PricingModel

pLocale - the locale for this pricing

pProfile - The user's profile

pOrder - The Order object of which the List of items are a part, may be null

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

Throws:

PricingException - if there was a problem in determining an item's price

findAdjustedPriceWithinGroup

public double findAdjustedPriceWithinGroup(DetailedItemPriceInfo pDetailedItemPriceInfo,
                                           RepositoryItem pPricingModel,
                                           java.util.Locale pLocale,
                                           double pGroupTotal,
                                           java.util.Map pExtraParameters)
                                    throws PricingException

Parameters:

pDetailedItemPriceInfo - - Detailed Item Price Info whose price we will adjust

pPricingModel - - Pricing Model including the discount type and amount

pLocale - the locale in which the items are to be discounted

pGroupTotal - - total value of the current group

pExtraParameters - any extra information that this method might need to set the prices of a number of the qualifying item

Returns:

a double representing the new price for the dipi passed in.

Throws:

PricingException

getCalculatorInfo

public CalculatorInfo getCalculatorInfo()

Retrieve information about this calculator.

Specified by:

getCalculatorInfo in interface CalculatorInfoProvider

Returns:

a CalculatorInfo object relating to this calculator

buildGroups

protected java.util.Map<java.lang.Integer,atg.commerce.pricing.DiscountGroup> buildGroups(java.util.Collection qualifyingItems)
                                                                                   throws PricingException

Build a structure which places quantities of qualified detailed item price infos into groups for purposes of discounting.

Parameters:

qualifyingItems - - the items whose detailed item price infos we wish to place into groups.

Returns:

A structure which organises detailed item price infos into groups for discounting.

Throws:

PricingException

updateQualifiedItems

protected void updateQualifiedItems(java.util.Collection pQualifiedItems,
                                    java.util.Map pExtraParameters)
                             throws PricingException

Update a qualified item to reflect any re-pricing operations carried out on its associated dipis.

Parameters:

pQualifiedItems - - the items we wish to update

pExtraParameters - any extra information that this method might need to set the prices of a number of the qualifying item

Throws:

PricingException

priceGroup

protected void priceGroup(atg.commerce.pricing.DiscountGroup pDiscountGroup,
                          RepositoryItem pPricingModel,
                          java.util.Locale pLocale,
                          double pGroupTotal,
                          java.util.Map pExtraParameters)
                   throws PricingException

Re-prices dipis within a group according to the pricing model passed in. Calls into handleLeftOvers method to deal with any precision lost due to rounding.

Parameters:

pPricingModel - - the pricing model which will tell us the size and kind of discount to apply.

pLocale - - the locale in which the items are to be discounted

pGroupTotal - - The current total cost of all items in the group.

pExtraParameters - - any extra information that this method might need to set the prices of a number of the qualifying item

Throws:

PricingException

handleLeftOvers

protected void handleLeftOvers(java.util.List<DetailedItemPriceInfo> pDetails,
                               double pLeftOvers)

This method deals with the case where precision may be lost when applying discount to multiple items due to rounding. It does this by sharing out the leftovers passed in 'pLeftOvers' to the detailed item price infos 'pDetails'. It will work over pDetails in reverse order, trying to give the full amount of pLeftOvers to the last item in the list, last item is used first as it will have been the last item to have received a pricing adjustment. If the last item in the list is unable to receive the full amount of left overs i.e if it will push it into a negative price, this detailed item price info will take a portion of the leftovers and the next detailed item price info will take the remaining leftovers or a portion of it, and so on until all the left overs have been dealt out.

Parameters:

pDetails - List of DetailedItemPriceInfo for items in the group

pLeftOvers - The money lost through the rounding process that need to be re-distributed into the DIPIs

handleLeftOvers

protected void handleLeftOvers(java.util.List<DetailedItemPriceInfo> pDetails,
                               double pLeftOvers,
                               java.lang.String pCurrencyCode)

This method deals with the case where precision may be lost when applying discount to multiple items due to rounding. It does this by sharing out the leftovers passed in 'pLeftOvers' to the detailed item price infos 'pDetails'. It will work over pDetails in reverse order, trying to give the full amount of pLeftOvers to the last item in the list, last item is used first as it will have been the last item to have received a pricing adjustment. If the last item in the list is unable to receive the full amount of left overs i.e if it will push it into a negative price, this detailed item price info will take a portion of the leftovers and the next detailed item price info will take the remaining leftovers or a portion of it, and so on until all the left overs have been dealt out.

Parameters:

pDetails - List of DetailedItemPriceInfo for items in the group

pLeftOvers - The money lost through the rounding process that need to be re-distributed into the DIPIs *

pCurrencyCode - the currency code whose number of decimal places will be used in any rounding operations