atg.commerce.pricing
Class Qualifier

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

All Implemented Interfaces:

PromotionQualifyingFilter, 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 Qualifier
extends GenericService
implements PromotionQualifyingFilter

A Helper class for discount calculators. Calculators call their helper method in this class to determine to which items they should apply their discount. As a side effect, the Qualifier also keeps track of which items acted as qualifiers for the input promotion, if applicable, and marks their priceInfos as appropriate.

• ItemDiscountCalculator uses findQualifyingItems
• OrderDiscountCalculator uses findQualifyingOrder
• ShippingDiscountCalculator uses findQualifyingShipping
• TaxDiscountCalculator uses findQualifyingOrder

This class can be extended. New "findQualifyingX" methods can be added to act as helper methods to new kinds of PricingCalculator. Any calculator that needs a rule to determine whether to apply a discount might use the Qualifier class.

By default, the Qualifier evaluates rules written in PMDL (Pricing Model Description Language). evaluateQualifier and evaluateTarget evaluate the qualifier and target elements of PMDL respectively. The evaluateQualfier and evaluateTarget methods are protected and are available to be extended.

• licenseFileNames is the component names of the license files which this component requires.
• pmdlCache is the cache which maps pricing model RepositoryItems to their parsed PMDL bean representations.
• pricingModelProperties is a list of the names of the properties of a pricing model RepositoryItem.

There are a number of properties that can be configured to adjust the way in which CommerceItems are allowed to participate in pricing rule evaluation. There are two rules which make up a PMDL rule: the qualifier rule and target rule. Accordingly, there two categories of filter property: filterForQualifier and filterForTarget.

In all of the properties listed below, a value of true indicates that items with the specified attributes should be excluded from the qualification process.

Qualifier filters:

• filterForQualifierNegativePrices: default = true. Toggle whether items with negative prices should be allowed to act as qualifiers.
• filterForQualifierZeroPrices: default = true. Toggle whether items with zero prices should be allowed to act as qualifiers
• filterForQualifierOnSale: default = false. Toggle whether items that were priced with a sale price should be allowed to act as qualifiers
• filterForQualifierDiscountedByCurrentDiscountId: default = true. Toggle whether items discounted by the "current" discount should be allowed to act as qualifiers
• filterForQualifierDiscountedByAnyDiscountId: default = true. Toggle whether items discounted by any discount should be allowed to act as qualifiers. Masks filterForQualifierDiscountedByCurrentDiscountId (if this property is on, it doesn't matter what the other property is set to)

Target filters:

• filterForTargetNegativePrices: default = true. Toggle whether items with negative prices should be allowed to receive the current discount
• filterForTargetZeroPrices: default = true. Toggle whether items with zero prices should be allowed to receive the current discount
• filterForTargetPricesLessThanOrEqualToPromotionPrice: default = true. Toggle whether items with prices that are already less than the price that would be granted by a "fixed price" promotion should receive the promotion.
• filterForTargetOnSale: default = false. Toggle whether items that were priced with a sale price should be allowed to receive the current discount
• filterForTargetDiscountedByCurrentDiscountId: default = true. Toggle whether items that have been discounted by the current discount should be allowed to receive the discount again
• filterForTargetDiscountedByAnyDiscountId: default = true. toggle whether items that have been discounted by any discount should be allowed to receive the discount again
• filterForTargetActedAsQualifierForAnyDiscount: default = true. toggle whether items that have acted as a qualifier for any discount should be allowed to receive the current discount

  Nested Class Summary

  static class

  Qualifier.FilterFlag

  Field Summary

  static java.lang.String	CLASS_VERSION Class version string
  static java.lang.String	FILTER_FOR_QUALIFIER_ACTED_AS_QUALIFIER_FOR_ANY_DISCOUNT
  static java.lang.String	FILTER_FOR_QUALIFIER_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID
  static java.lang.String	FILTER_FOR_TARGET_NON_DISCOUNTABLE
  static java.lang.String	FILTER_FOR_TARGET_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID

  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

  Qualifier()
  

  Method Summary

  protected java.util.List<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails>	buildPromotionAnalysisItemDetails(java.util.List pItems, boolean pIsQualifier) Helper method used to convert a list of MatchingObjects into the required format for the PromotionAnalysisManager.
  protected long	calculateItemQuantityAvailable(FilteredCommerceItem pItem, boolean pIsQualifier) Calculate the quantity of this item that is available.
  protected DiscountStructure	checkTargetPricesLessThanOrEqualToPromotionPrice(java.util.List<DiscountStructure> pDiscountStructures) Deprecated. as of release 10.2 in order to support promotion filter flag overrides
  protected DiscountStructure	checkTargetPricesLessThanOrEqualToPromotionPrice(java.util.List<DiscountStructure> pDiscountStructures, PricingContext pPricingContext, java.util.Map pExtraParametersMap) Utility method to decide if we need to check items for filtering against prices less than or equal to the promotion price.
  protected java.util.Map	createPMDLBindings(java.util.List pItems, RepositoryItem pProfile, Order pOrder, ShippingGroup pShippingGroup, java.util.Locale pLocale, java.util.Map pExtraParametersMap) Deprecated. replaced by createPMDLBindings(PromotionQualifyingDetails)
  protected java.util.Map	createPMDLBindings(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.List pFilteredItems) Create the map of bindings that are used during evaluation of the any PMDL This will make the following bindings: ITEMS_BINDING_NAME -> pItems PROFILE_BINDING_NAME -> pProfile ORDER_BINDING_NAME -> pOrder SHIPPING_GROUP_BINDING_NAME -> pShippingGroup LOCALE_BINDING_NAME -> pLocale
  protected boolean	deriveFilterForTargetPriceLessThanOrEqualToPromotionPrice(PricingContext pPricingContext, java.util.Map pExtraParametersMap) Derive the correct value to use for the 'FilterForTargetPriceLessThanOrEqualToPromotionPrice' filter.
  protected void	doFilters(int pFilterContext, PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Map pDetailsPendingActingAsQualifier, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pFilteredItems) Loops through the configured filters to allow them to filter out items for the rule evaluations.
  void	doStartService() GenericService override
  protected java.lang.Object	evaluateQualifier(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by evaluateQualifier(PricingContext, Map, List)
  protected java.lang.Object	evaluateQualifier(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.List pFilteredQualifierItems) evaluates the qualifier of a cached PMDL rule.
  protected java.lang.Object	evaluateTarget(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by evaluateTarget(PricingContext, Map, List)
  protected java.lang.Object	evaluateTarget(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.List pFilteredTargetItems) evaluates the target of a cached PMDL rule.
  protected FilteredCommerceItem	filterItemByPrice(FilteredCommerceItem pItem, DiscountStructure pDiscountStructure) Deprecated. replaced by filterItemByPrice(FilteredCommerceItem,DiscountStructure, Map)
  FilteredCommerceItem	filterItemByPrice(FilteredCommerceItem pItem, DiscountStructure pDiscountStructure, java.util.Map pExtraParametersMap) This method will check if any of the given filtered commerce item should be filtered out because it's unit price is less than the fixed price discount.
  void	filterItems(int pFilterContext, PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Map pDetailsPendingActingAsQualifier, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pFilteredItems) Implementations should populate the filteredItems list with the appropriate items for the given filterContext.
  protected void	filterItemsForQualifier(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pNewPriceInfos, java.util.List pNewItems) Deprecated. replaced by filterItemsForQualifier(PricingContext, Map, Map, List)
  protected void	filterItemsForQualifier(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pFilteredQualifierItems) Filtering routine to remove quantities of the given items so that qualifier condition rules can be accurately evaluated.
  protected void	filterItemsForTarget(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap, java.util.Map pDetailsPendingActingAsQualifier, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pNewPriceInfos, java.util.List pNewItems) Deprecated. As of ATG10, replaced by filterItemsForTarget(PromotionQualifyingDetails,Map,Map,List).
  protected void	filterItemsForTarget(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Map pDetailsPendingActingAsQualifier, java.util.Map pDetailsRangesToReceiveDiscount, java.util.List pFilteredTargetItems) Filtering routine to remove quantities of the given items so that target offer rules can be accurately evaluated.
  protected boolean	filterShippingForTarget(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by filterShippingForTarget(PricingContext,Map)
  protected boolean	filterShippingForTarget(PricingContext pPricingContext, java.util.Map pExtraParametersMap) Filtering routine that checks if the given shipping group is allowed to receive the given discount (pPricingModel).
  java.util.Collection	findQualifyingItems(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by findQualifyingItems(PricingContext, Map)
  java.util.Collection	findQualifyingItems(PricingContext pPricingContext, java.util.Map pExtraParametersMap) Determines which items, if any, should receive a discount based on the given running environment.
  protected MatchingObject	findQualifyingObjectNoTargetEvaluation(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap, java.lang.Object pTarget) Deprecated. replaced by findQualifyingObjectNoTargetEvaluation(PricingContext, Map, Object)
  protected MatchingObject	findQualifyingObjectNoTargetEvaluation(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.lang.Object pTarget) This method is used by both findQualifyingOrder and findQualifyingShipping since they both use the same logic.
  MatchingObject	findQualifyingOrder(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by findQualifyingOrder(PricingContext, Map)
  MatchingObject	findQualifyingOrder(PricingContext pPricingContext, java.util.Map pExtraParametersMap) determines whether an order should receive a discount based on the given running environment.
  MatchingObject	findQualifyingShipping(java.util.List pPriceQuotes, java.util.List pItems, RepositoryItem pPricingModel, RepositoryItem pProfile, java.util.Locale pLocale, Order pOrder, OrderPriceInfo pOrderPriceInfo, ShippingGroup pShippingGroup, ShippingPriceInfo pShippingPriceInfo, java.util.Map pExtraParametersMap) Deprecated. replaced by findQualifyingShipping(PricingContext, Map)
  MatchingObject	findQualifyingShipping(PricingContext pPricingContext, java.util.Map pExtraParametersMap) determines whether a ShippingGroup should receive a discount based on the given running environment.
  AggregatorManager	getAggregatorManager() Returns the aggregation manager.
  int	getCallingContext() Get property CallingContext
  java.lang.String	getClosenessQualifierItemDescriptorName() Returns a the name of the closenessQualifier item descriptor
  java.lang.String	getDetailSortOrder() Getter for the detailSortOrder property, which is the order in which to order DIPI objects
  boolean	getFilterForQualifierDiscountedByAnyDiscountId() filter from the qualifier's pricing environment those items already discounted by any discount Id
  boolean	getFilterForQualifierDiscountedByCurrentDiscountId() filter from the qualifier's pricing environment those items already discounted by the current discount Id
  boolean	getFilterForQualifierNegativePrices() remove from the qualifier rule's pricing environment items whose price is negative
  boolean	getFilterForQualifierOnSale() remove from the qualifier rule's pricing environment items that were on sale
  boolean	getFilterForQualifierZeroPrices() remove from the qualifier rule's pricing environment items whose price is zero
  boolean	getFilterForTargetActedAsQualifierForAnyDiscount() remove from the target rule's pricing environment items who have acted as a target for any promotion
  boolean	getFilterForTargetDiscountedByAnyDiscountId() filter from the target's pricing environment those items already discounted by any discount Id
  boolean	getFilterForTargetDiscountedByCurrentDiscountId() filter from the target's pricing environment those items already discounted by the current discount Id
  boolean	getFilterForTargetNegativePrices() remove from the target rule's pricing environment items whose price is negative
  boolean	getFilterForTargetOnSale() remove from the target rule's pricing environment items that were on sale
  boolean	getFilterForTargetPricesLessThanOrEqualToPromotionPrice() remove from the target rule's pricing environment items whose price is already less or equal to the price it will be given by a "fixed price" promotion
  boolean	getFilterForTargetZeroPrices() remove from the target rule's pricing environment items whose price is zero
  PromotionQualifyingFilter[]	getFilters() Returns property Filters
  java.util.Map<java.lang.String,java.lang.Boolean>	getGlobalFilters() Returns a map of the global filters.
  Cache	getPMDLCache() Get property PMDLCache
  PricingModelProperties	getPricingModelProperties() Returns a bean that contains properties for a PricingModel
  Repository	getPricingModelRepository() Returns the repository that holds the pricing model information.
  PricingTools	getPricingTools() Returns PricingTools
  protected java.util.Map<java.lang.String,java.lang.Boolean>	getPromotionFilters(RepositoryItem pPricingModel) Returns a map of the promotion filters.
  PromotionTools	getPromotionTools() Returns PromotionTools
  protected boolean	isClosenessQualifier(RepositoryItem pPricingModel) Method checks if the pricing model is a closeness qualifier.
  boolean	isDiscountableItem(FilteredCommerceItem pItem) Determines if a FilteredCommerceItem is discountable or not.
  boolean	isExactlyPromotionLoopThrough() If true, Exactly promotion will try to loop through all items in collecion.
  boolean	isFilterForQualifierDiscountedByAnyDiscountId() Test property FilterForQualifierDiscountedByAnyDiscountId
  boolean	isFilterForQualifierDiscountedByCurrentDiscountId() Test property FilterForQualifierDiscountedByCurrentDiscountId
  boolean	isFilterForQualifierNegativePrices() Test property FilterForQualifierNegativePrices
  boolean	isFilterForQualifierOnSale() Test property FilterForQualifierOnSale
  boolean	isFilterForQualifierZeroPrices() Test property FilterForQualifierZeroPrices
  boolean	isFilterForTargetActedAsQualifierForAnyDiscount() Test property FilterForTargetActedAsQualifierForAnyDiscount
  boolean	isFilterForTargetDiscountedByAnyDiscountId() Test property FilterForTargetDiscountedByAnyDiscountId
  boolean	isFilterForTargetDiscountedByCurrentDiscountId() Test property FilterForTargetDiscountedByCurrentDiscountId
  boolean	isFilterForTargetNegativePrices() Test property FilterForTargetNegativePrices
  boolean	isFilterForTargetOnSale() Test property FilterForTargetOnSale
  boolean	isFilterForTargetPricesLessThanOrEqualToPromotionPrice() Test property FilterForTargetPricesLessThanOrEqualToPromotionPrice
  boolean	isFilterForTargetZeroPrices() Test property FilterForTargetZeroPrices
  protected void	markQualifierItems(java.util.List pItemsFromQualifier, java.util.Map pItemsPendingActingAsQualifier) This method marks the matching objects that were returned by the evaluateQualifier method as having acted as qualifiers during this iteration.
  protected void	processPromotionAnalysisFilterInformation(java.util.Map<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails,java.lang.String> pFilterDetails, CommerceItem pCommerceItem, java.util.List<atg.core.util.Range> pRanges, java.lang.String pTriggerCause, java.util.Map pExtraParametersMap) Helper method for promotion analysis used to process filter details.
  protected void	processPromotionAnalysisFilterInformation(java.util.Map<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails,java.lang.String> pFilterDetails, CommerceItem pCommerceItem, long pQuantity, java.lang.String pTriggerCause, java.util.Map pExtraParametersMap) Helper method for promotion analysis used to process filter details.
  protected void	processPromotionAnalysisInformation(PricingContext pPricingContext, boolean pConditionEvaluatedFirst, boolean pValidationStageExecuted, int pIteration, java.util.Map pExtraParametersMap) Helper method used to set condition and offer promotion analysis information in the holder object.
  protected void	processPromotionAnalysisInformation(PricingContext pPricingContext, boolean pConditionEvaluatedFirst, int pIteration, java.util.List<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails> pQualifierItems, java.lang.Boolean pQualifierPassed, java.lang.Boolean pOfferPassed, java.util.Map pExtraParametersMap) Helper method used to set condition and offer promotion analysis information in the holder object.
  protected atg.commerce.pricing.Qualifier.ProcessReturn	processQualifier(PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Map pDetailsPendingActingAsQualifier, java.util.Map pDetailsTaggedToReceiveDiscount, java.util.Map pOriginalItemQuantities) Carry out a call to evaluateQualifier and process the return.
  protected atg.commerce.pricing.Qualifier.ProcessReturn	processTarget(java.lang.Object pTargetRet, PricingContext pPricingContext, java.util.Map pExtraParametersMap, java.util.Collection<QualifiedItem> pQualifiedItems, java.util.Map<java.lang.String,java.util.Map<java.lang.String,QualifiedItem>> pQualifiedItemsDetails, java.util.Map pDetailsTaggedToReceiveDiscount) Processes the return from a call to evaluateTarget.
  void	setAggregatorManager(AggregatorManager pAggregatorManager)
  void	setCallingContext(int pCallingContext) Set property CallingContext
  void	setClosenessQualifierItemDescriptorName(java.lang.String pClosenessQualifierItemDescriptorName)
  void	setDetailSortOrder(java.lang.String pDetailSortOrder)
  void	setExactlyPromotionLoopThrough(boolean pExactlyPromotionLoopThrough)
  void	setFilterForQualifierDiscountedByAnyDiscountId(boolean pFilterForQualifierDiscountedByAnyDiscountId) filter from the qualifier's pricing environment those items already discounted by the current discount Id
  void	setFilterForQualifierDiscountedByCurrentDiscountId(boolean pFilterForQualifierDiscountedByCurrentDiscountId) filter from the qualifier's pricing environment those items already discounted by the current discount Id
  void	setFilterForQualifierNegativePrices(boolean pFilterForQualifierNegativePrices) remove from the qualifier rule's pricing environment items whose price is negative
  void	setFilterForQualifierOnSale(boolean pFilterForQualifierOnSale) remove from the qualifier rule's pricing environment items that were on sale
  void	setFilterForQualifierZeroPrices(boolean pFilterForQualifierZeroPrices) remove from the qualifier rule's pricing environment items whose price is zero
  void	setFilterForTargetActedAsQualifierForAnyDiscount(boolean pFilterForTargetActedAsQualifierForAnyDiscount) remove from the target rule's pricing environment items who have acted as a target for any promotion
  void	setFilterForTargetDiscountedByAnyDiscountId(boolean pFilterForTargetDiscountedByAnyDiscountId) filter from the target's pricing environment those items already discounted by the current discount Id
  void	setFilterForTargetDiscountedByCurrentDiscountId(boolean pFilterForTargetDiscountedByCurrentDiscountId) filter from the target's pricing environment those items already discounted by the current discount Id
  void	setFilterForTargetNegativePrices(boolean pFilterForTargetNegativePrices) remove from the target rule's pricing environment items whose price is negative
  void	setFilterForTargetOnSale(boolean pFilterForTargetOnSale) remove from the target rule's pricing environment items that were on sale
  void	setFilterForTargetPricesLessThanOrEqualToPromotionPrice(boolean pFilterForTargetPricesLessThanOrEqualToPromotionPrice) remove from the target rule's pricing environment items whose price is already less or equal to the price it will be given by a "fixed price" promotion
  void	setFilterForTargetZeroPrices(boolean pFilterForTargetZeroPrices) remove from the target rule's pricing environment items whose price is zero
  void	setFilters(PromotionQualifyingFilter[] pFilters) Sets property Filters
  void	setPMDLCache(Cache pPMDLCache) Set property PMDLCache
  void	setPricingModelProperties(PricingModelProperties pPricingModelProperties)
  void	setPricingModelRepository(Repository pPricingModelRepository)
  void	setPricingTools(PricingTools pPricingTools) Sets PricingTools
  void	setPromotionTools(PromotionTools pPromotionTools) Sets PromotionTools
  protected java.util.Map	tagDetailsAsDiscounted(ItemPriceInfo pItemPrice, FilteredCommerceItem pItem, long pMatchingQuantity, QualifiedItem pQualifiedItem, java.util.Map pDetailsTaggedToReceiveDiscount) This method will cycle through the qualified item targeted by the pricing model and marks the correct details as discounted.
  protected void	tagTargetItems(java.lang.Object pTargetEvalValue, java.util.Map pDetailsTaggedToReceiveDiscount) Tag the the items returned from the target evaluation by marking them in the pDetailsTaggedToReceiveDiscount map, using the tagDetailsAsDiscounted method.
  protected boolean	validatePromotion(PricingContext pPricingContext, java.util.Map pExtraParameters) Method to do up front validation of a promotion to determine if it isn't valid for further evaluation. This method should only return false if it can guarantee that the promotion could not qualify and find a valid target. This validation is performed on an unfiltered and unsorted list of commerce items in the cart. The purpose of the method is to improve performance by avoiding a full evaluation of a promotion if possible.
  protected java.util.List	wrapCommerceItems(java.util.List pItems, java.util.List pPriceQuotes) produce a list of FilteredCommerceItems from a list of CommerceItems

  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

  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 final java.lang.String CLASS_VERSION

  Class version string

  See Also:

  Constant Field Values

  FILTER_FOR_QUALIFIER_ACTED_AS_QUALIFIER_FOR_ANY_DISCOUNT

  public static final java.lang.String FILTER_FOR_QUALIFIER_ACTED_AS_QUALIFIER_FOR_ANY_DISCOUNT

  See Also:

  Constant Field Values

  FILTER_FOR_QUALIFIER_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID

  public static final java.lang.String FILTER_FOR_QUALIFIER_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID

  See Also:

  Constant Field Values

  FILTER_FOR_TARGET_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID

  public static final java.lang.String FILTER_FOR_TARGET_TO_BE_DISCOUNTED_BY_ANY_DISCOUNT_ID

  See Also:

  Constant Field Values

  FILTER_FOR_TARGET_NON_DISCOUNTABLE

  public static final java.lang.String FILTER_FOR_TARGET_NON_DISCOUNTABLE

  See Also:

  Constant Field Values

  Constructor Detail

  Qualifier

  public Qualifier()

  Method Detail

  setPricingTools

  public void setPricingTools(PricingTools pPricingTools)

  Sets PricingTools

  getPricingTools

  public PricingTools getPricingTools()

  Returns PricingTools

  setPromotionTools

  public void setPromotionTools(PromotionTools pPromotionTools)

  Sets PromotionTools

  getPromotionTools

  public PromotionTools getPromotionTools()

  Returns PromotionTools

  setFilters

  public void setFilters(PromotionQualifyingFilter[] pFilters)

  Sets property Filters

  getFilters

  public PromotionQualifyingFilter[] getFilters()

  Returns property Filters

  setPMDLCache

  public void setPMDLCache(Cache pPMDLCache)

  Set property PMDLCache

  Parameters:

  pPMDLCache - new value to set

  getPMDLCache

  public Cache getPMDLCache()

  Get property PMDLCache

  Returns:

  PMDLCache

  setPricingModelProperties

  public void setPricingModelProperties(PricingModelProperties pPricingModelProperties)

  getPricingModelProperties

  public PricingModelProperties getPricingModelProperties()

  Returns a bean that contains properties for a PricingModel

  setClosenessQualifierItemDescriptorName

  public void setClosenessQualifierItemDescriptorName(java.lang.String pClosenessQualifierItemDescriptorName)

  getClosenessQualifierItemDescriptorName

  public java.lang.String getClosenessQualifierItemDescriptorName()

  Returns a the name of the closenessQualifier item descriptor

  setPricingModelRepository

  public void setPricingModelRepository(Repository pPricingModelRepository)

  getPricingModelRepository

  public Repository getPricingModelRepository()

  Returns the repository that holds the pricing model information.

  setAggregatorManager

  public void setAggregatorManager(AggregatorManager pAggregatorManager)

  getAggregatorManager

  public AggregatorManager getAggregatorManager()

  Returns the aggregation manager.

  Returns:

  the aggregation manager

  setDetailSortOrder

  public void setDetailSortOrder(java.lang.String pDetailSortOrder)

  getDetailSortOrder

  public java.lang.String getDetailSortOrder()

  Getter for the detailSortOrder property, which is the order in which to order DIPI objects

  Returns:

  String sort order

  setCallingContext

  public void setCallingContext(int pCallingContext)

  Set property CallingContext

  Parameters:

  pCallingContext - new value to set

  getCallingContext

  public int getCallingContext()

  Get property CallingContext

  Returns:

  the calling context

  setFilterForQualifierNegativePrices

  public void setFilterForQualifierNegativePrices(boolean pFilterForQualifierNegativePrices)

  remove from the qualifier rule's pricing environment items whose price is negative

  Parameters:

  pFilterForQualifierNegativePrices - new value to set

  getFilterForQualifierNegativePrices

  public boolean getFilterForQualifierNegativePrices()

  remove from the qualifier rule's pricing environment items whose price is negative

  Returns:

  property FilterForQualifierNegativePrices

  isFilterForQualifierNegativePrices

  public boolean isFilterForQualifierNegativePrices()

  Test property FilterForQualifierNegativePrices

  Returns:

  FilterForQualifierNegativePrices

  setFilterForQualifierZeroPrices

  public void setFilterForQualifierZeroPrices(boolean pFilterForQualifierZeroPrices)

  remove from the qualifier rule's pricing environment items whose price is zero

  Parameters:

  pFilterForQualifierZeroPrices - new value to set

  getFilterForQualifierZeroPrices

  public boolean getFilterForQualifierZeroPrices()

  remove from the qualifier rule's pricing environment items whose price is zero

  Returns:

  property FilterForQualifierZeroPrices

  isFilterForQualifierZeroPrices

  public boolean isFilterForQualifierZeroPrices()

  Test property FilterForQualifierZeroPrices

  Returns:

  FilterForQualifierZeroPrices

  setFilterForQualifierOnSale

  public void setFilterForQualifierOnSale(boolean pFilterForQualifierOnSale)

  remove from the qualifier rule's pricing environment items that were on sale

  Parameters:

  pFilterForQualifierOnSale - new value to set

  getFilterForQualifierOnSale

  public boolean getFilterForQualifierOnSale()

  remove from the qualifier rule's pricing environment items that were on sale

  Returns:

  property FilterForQualifierOnSale

  isFilterForQualifierOnSale

  public boolean isFilterForQualifierOnSale()

  Test property FilterForQualifierOnSale

  Returns:

  FilterForQualifierOnSale

  setFilterForQualifierDiscountedByCurrentDiscountId

  public void setFilterForQualifierDiscountedByCurrentDiscountId(boolean pFilterForQualifierDiscountedByCurrentDiscountId)

  filter from the qualifier's pricing environment those items already discounted by the current discount Id

  Parameters:

  pFilterForQualifierDiscountedByCurrentDiscountId - new value to set

  getFilterForQualifierDiscountedByCurrentDiscountId

  public boolean getFilterForQualifierDiscountedByCurrentDiscountId()

  filter from the qualifier's pricing environment those items already discounted by the current discount Id

  Returns:

  property FilterForQualifierDiscountedByCurrentDiscountId

  isFilterForQualifierDiscountedByCurrentDiscountId

  public boolean isFilterForQualifierDiscountedByCurrentDiscountId()

  Test property FilterForQualifierDiscountedByCurrentDiscountId

  Returns:

  FilterForQualifierDiscountedByCurrentDiscountId

  setFilterForQualifierDiscountedByAnyDiscountId

  public void setFilterForQualifierDiscountedByAnyDiscountId(boolean pFilterForQualifierDiscountedByAnyDiscountId)

  filter from the qualifier's pricing environment those items already discounted by the current discount Id

  Parameters:

  pFilterForQualifierDiscountedByAnyDiscountId - new value to set

  getFilterForQualifierDiscountedByAnyDiscountId

  public boolean getFilterForQualifierDiscountedByAnyDiscountId()

  filter from the qualifier's pricing environment those items already discounted by any discount Id

  Returns:

  property FilterForQualifierDiscountedByAnyDiscountId

  isFilterForQualifierDiscountedByAnyDiscountId

  public boolean isFilterForQualifierDiscountedByAnyDiscountId()

  Test property FilterForQualifierDiscountedByAnyDiscountId

  Returns:

  FilterForQualifierDiscountedByAnyDiscountId

  setFilterForTargetNegativePrices

  public void setFilterForTargetNegativePrices(boolean pFilterForTargetNegativePrices)

  remove from the target rule's pricing environment items whose price is negative

  Parameters:

  pFilterForTargetNegativePrices - new value to set

  getFilterForTargetNegativePrices

  public boolean getFilterForTargetNegativePrices()

  remove from the target rule's pricing environment items whose price is negative

  Returns:

  property FilterForTargetNegativePrices

  isFilterForTargetNegativePrices

  public boolean isFilterForTargetNegativePrices()

  Test property FilterForTargetNegativePrices

  Returns:

  FilterForTargetNegativePrices

  setFilterForTargetZeroPrices

  public void setFilterForTargetZeroPrices(boolean pFilterForTargetZeroPrices)

  remove from the target rule's pricing environment items whose price is zero

  Parameters:

  pFilterForTargetZeroPrices - new value to set

  getFilterForTargetZeroPrices

  public boolean getFilterForTargetZeroPrices()

  remove from the target rule's pricing environment items whose price is zero

  Returns:

  property FilterForTargetZeroPrices

  isFilterForTargetZeroPrices

  public boolean isFilterForTargetZeroPrices()

  Test property FilterForTargetZeroPrices

  Returns:

  FilterForTargetZeroPrices

  setFilterForTargetPricesLessThanOrEqualToPromotionPrice

  public void setFilterForTargetPricesLessThanOrEqualToPromotionPrice(boolean pFilterForTargetPricesLessThanOrEqualToPromotionPrice)

  remove from the target rule's pricing environment items whose price is already less or equal to the price it will be given by a "fixed price" promotion

  Parameters:

  pFilterForTargetPricesLessThanOrEqualToPromotionPrice - new value to set

  getFilterForTargetPricesLessThanOrEqualToPromotionPrice

  public boolean getFilterForTargetPricesLessThanOrEqualToPromotionPrice()

  remove from the target rule's pricing environment items whose price is already less or equal to the price it will be given by a "fixed price" promotion

  Returns:

  property FilterForTargetPricesLessThanOrEqualToPromotionPrice

  isFilterForTargetPricesLessThanOrEqualToPromotionPrice

  public boolean isFilterForTargetPricesLessThanOrEqualToPromotionPrice()

  Test property FilterForTargetPricesLessThanOrEqualToPromotionPrice

  Returns:

  FilterForTargetPricesLessThanOrEqualToPromotionPrice

  setFilterForTargetOnSale

  public void setFilterForTargetOnSale(boolean pFilterForTargetOnSale)

  remove from the target rule's pricing environment items that were on sale

  Parameters:

  pFilterForTargetOnSale - new value to set

  getFilterForTargetOnSale

  public boolean getFilterForTargetOnSale()

  remove from the target rule's pricing environment items that were on sale

  Returns:

  property FilterForTargetOnSale

  isFilterForTargetOnSale

  public boolean isFilterForTargetOnSale()

  Test property FilterForTargetOnSale

  Returns:

  FilterForTargetOnSale

  setFilterForTargetDiscountedByCurrentDiscountId

  public void setFilterForTargetDiscountedByCurrentDiscountId(boolean pFilterForTargetDiscountedByCurrentDiscountId)

  filter from the target's pricing environment those items already discounted by the current discount Id

  Parameters:

  pFilterForTargetDiscountedByCurrentDiscountId - new value to set

  getFilterForTargetDiscountedByCurrentDiscountId

  public boolean getFilterForTargetDiscountedByCurrentDiscountId()

  filter from the target's pricing environment those items already discounted by the current discount Id

  Returns:

  property FilterForTargetDiscountedByCurrentDiscountId

  isFilterForTargetDiscountedByCurrentDiscountId

  public boolean isFilterForTargetDiscountedByCurrentDiscountId()

  Test property FilterForTargetDiscountedByCurrentDiscountId

  Returns:

  FilterForTargetDiscountedByCurrentDiscountId

  setFilterForTargetDiscountedByAnyDiscountId

  public void setFilterForTargetDiscountedByAnyDiscountId(boolean pFilterForTargetDiscountedByAnyDiscountId)

  filter from the target's pricing environment those items already discounted by the current discount Id

  Parameters:

  pFilterForTargetDiscountedByAnyDiscountId - new value to set

  getFilterForTargetDiscountedByAnyDiscountId

  public boolean getFilterForTargetDiscountedByAnyDiscountId()

  filter from the target's pricing environment those items already discounted by any discount Id

  Returns:

  property FilterForTargetDiscountedByAnyDiscountId

  isFilterForTargetDiscountedByAnyDiscountId

  public boolean isFilterForTargetDiscountedByAnyDiscountId()

  Test property FilterForTargetDiscountedByAnyDiscountId

  Returns:

  FilterForTargetDiscountedByAnyDiscountId

  setFilterForTargetActedAsQualifierForAnyDiscount

  public void setFilterForTargetActedAsQualifierForAnyDiscount(boolean pFilterForTargetActedAsQualifierForAnyDiscount)

  remove from the target rule's pricing environment items who have acted as a target for any promotion

  Parameters:

  pFilterForTargetActedAsQualifierForAnyDiscount - new value to set

  getFilterForTargetActedAsQualifierForAnyDiscount

  public boolean getFilterForTargetActedAsQualifierForAnyDiscount()

  remove from the target rule's pricing environment items who have acted as a target for any promotion

  Returns:

  property FilterForTargetActedAsQualifierForAnyDiscount

  isFilterForTargetActedAsQualifierForAnyDiscount

  public boolean isFilterForTargetActedAsQualifierForAnyDiscount()

  Test property FilterForTargetActedAsQualifierForAnyDiscount

  Returns:

  FilterForTargetActedAsQualifierForAnyDiscount

  findQualifyingOrder

  @Deprecated
  public MatchingObject findQualifyingOrder(java.util.List pPriceQuotes,
                                                       java.util.List pItems,
                                                       RepositoryItem pPricingModel,
                                                       RepositoryItem pProfile,
                                                       java.util.Locale pLocale,
                                                       Order pOrder,
                                                       OrderPriceInfo pOrderPriceInfo,
                                                       ShippingGroup pShippingGroup,
                                                       ShippingPriceInfo pShippingPriceInfo,
                                                       java.util.Map pExtraParametersMap)
                                     throws PricingException

  Deprecated. replaced by findQualifyingOrder(PricingContext, Map)

  determines whether an order should receive a discount based on the given running environment. The running evironment is represented by the parameters that are passed in.

  This method will call findQualifyingObjectNoTargetEvaluation

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input CommerceItems are wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any.

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a MatchingObject object which specifies the order that should be discounted, if any

  Throws:

  PricingException

  See Also:

  findQualifyingObjectNoTargetEvaluation(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.lang.Object)

  findQualifyingOrder

  public MatchingObject findQualifyingOrder(PricingContext pPricingContext,
                                            java.util.Map pExtraParametersMap)
                                     throws PricingException

  determines whether an order should receive a discount based on the given running environment. The running evironment is represented by the parameters that are passed in.

  This method will call findQualifyingObjectNoTargetEvaluation

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input CommerceItems must be wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPricingContext - PricingContext environment

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a MatchingObject object which specifies the order that should be discounted, if any

  Throws:

  PricingException

  See Also:

  findQualifyingObjectNoTargetEvaluation(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.lang.Object)

  findQualifyingShipping

  @Deprecated
  public MatchingObject findQualifyingShipping(java.util.List pPriceQuotes,
                                                          java.util.List pItems,
                                                          RepositoryItem pPricingModel,
                                                          RepositoryItem pProfile,
                                                          java.util.Locale pLocale,
                                                          Order pOrder,
                                                          OrderPriceInfo pOrderPriceInfo,
                                                          ShippingGroup pShippingGroup,
                                                          ShippingPriceInfo pShippingPriceInfo,
                                                          java.util.Map pExtraParametersMap)
                                        throws PricingException

  Deprecated. replaced by findQualifyingShipping(PricingContext, Map)

  determines whether a ShippingGroup should receive a discount based on the given running environment. The running evironment is represented by the parameters that are passed in.

  This method will first call filterShippingForTarget. If that returns true then, this method will call findQualifyingObjectNoTargetEvaluation.

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input CommerceItems are wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a MatchingObject object which specifes the ShippingGroup to be discounted, if any. null otherwise

  Throws:

  PricingException

  See Also:

  findQualifyingObjectNoTargetEvaluation(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.lang.Object)

  findQualifyingShipping

  public MatchingObject findQualifyingShipping(PricingContext pPricingContext,
                                               java.util.Map pExtraParametersMap)
                                        throws PricingException

  determines whether a ShippingGroup should receive a discount based on the given running environment. The running evironment is represented by the parameters that are passed in.

  This method will first call filterShippingForTarget. If that returns true then, this method will call findQualifyingObjectNoTargetEvaluation.

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input CommerceItems must be wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPricingContext - PricingContext environment

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a MatchingObject object which specifes the ShippingGroup to be discounted, if any. null otherwise

  Throws:

  PricingException

  See Also:

  findQualifyingObjectNoTargetEvaluation(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.lang.Object)

  findQualifyingItems

  @Deprecated
  public java.util.Collection findQualifyingItems(java.util.List pPriceQuotes,
                                                             java.util.List pItems,
                                                             RepositoryItem pPricingModel,
                                                             RepositoryItem pProfile,
                                                             java.util.Locale pLocale,
                                                             Order pOrder,
                                                             OrderPriceInfo pOrderPriceInfo,
                                                             ShippingGroup pShippingGroup,
                                                             ShippingPriceInfo pShippingPriceInfo,
                                                             java.util.Map pExtraParametersMap)
                                           throws PricingException

  Deprecated. replaced by findQualifyingItems(PricingContext, Map)

  determines which items, if any, should receive a discount based on the given running environment. The running environment is represented by the parameters that are passed in.

  This method will first call filterItemsForQualifier to remove items that should not be available while processing the PMDL rule. It will then call evaluateQualifier to see if the shipping group qualifies for the given promotion (pPricingModel). It is possible evaluateQualifier will be called more than once to see if the promotion is applicable more than once.

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input CommerceItems are wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a list of QualifiedItem objects that map a CommerceItem to the number of times it qualified

  Throws:

  PricingException

  See Also:

  filterItemsForQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.util.Map, java.util.List, java.util.List), evaluateQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map), evaluateTarget(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map)

  findQualifyingItems

  public java.util.Collection findQualifyingItems(PricingContext pPricingContext,
                                                  java.util.Map pExtraParametersMap)
                                           throws PricingException

  Determines which items, if any, should receive a discount based on the given running environment. The running environment is represented by the parameters that are passed in.

  This method will first call filterItemsForQualifier to remove items that should not be available while processing the PMDL rule. It will then call evaluateQualifier to see if the shipping group qualifies for the given promotion (pPricingModel). It is possible evaluateQualifier will be called more than once to see if the promotion is applicable more than once.

  NOTE: because findQualifyingOrder needs to tinker with a CommerceItem's quantity, input pricingContext CommerceItems should be wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPricingContext - Pricing parameters where Items should be FilteredCommerceItem's

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  a list of QualifiedItem objects that map a CommerceItem to the number of times it qualified

  Throws:

  PricingException - if an error occurred during processing

  See Also:

  filterItemsForQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.util.Map, java.util.List, java.util.List), evaluateQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map), evaluateTarget(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map)

  isDiscountableItem

  public boolean isDiscountableItem(FilteredCommerceItem pItem)
                             throws CommerceException

  Determines if a FilteredCommerceItem is discountable or not. If the property value discountable is not set then set it.

  Parameters:

  pItem - the FilteredCommerceItem

  Returns:

  true if the FilteredCommerceItem is discountable, otherwise it should return false.

  Throws:

  CommerceException

  tagTargetItems

  protected void tagTargetItems(java.lang.Object pTargetEvalValue,
                                java.util.Map pDetailsTaggedToReceiveDiscount)

  Tag the the items returned from the target evaluation by marking them in the pDetailsTaggedToReceiveDiscount map, using the tagDetailsAsDiscounted method. Used to stop target items from acting as qualifiers.

  Parameters:

  pTargetEvalValue - value returned from the call to evaluateTarget

  pDetailsTaggedToReceiveDiscount - map of dipis tagged to receive a discount

  processQualifier

  protected atg.commerce.pricing.Qualifier.ProcessReturn processQualifier(PricingContext pPricingContext,
                                                                          java.util.Map pExtraParametersMap,
                                                                          java.util.Map pDetailsPendingActingAsQualifier,
                                                                          java.util.Map pDetailsTaggedToReceiveDiscount,
                                                                          java.util.Map pOriginalItemQuantities)
                                                                   throws PricingException

  Carry out a call to evaluateQualifier and process the return. A return object holds the result from the evaluation and also a boolean value indicating if further processing should stop.

  Processing should stop if a null value or false value was returned from the evaluateQualifier call.

  Parameters:

  pPricingContext - Pricing parameters where Items should be FilteredCommerceItem's

  pExtraParametersMap - any extra information that might need to be passed in

  pDetailsPendingActingAsQualifier - map of dipis pending as acting as qualifier

  pDetailsTaggedToReceiveDiscount - map of dipis tagged to receive a discount

  pOriginalItemQuantities - original item quantities

  Returns:

  a return object containing the result of the qualifier evaluation and a boolean indicating whether to stop processing

  Throws:

  PricingException - if an error occurred during processing

  processTarget

  protected atg.commerce.pricing.Qualifier.ProcessReturn processTarget(java.lang.Object pTargetRet,
                                                                       PricingContext pPricingContext,
                                                                       java.util.Map pExtraParametersMap,
                                                                       java.util.Collection<QualifiedItem> pQualifiedItems,
                                                                       java.util.Map<java.lang.String,java.util.Map<java.lang.String,QualifiedItem>> pQualifiedItemsDetails,
                                                                       java.util.Map pDetailsTaggedToReceiveDiscount)
                                                                throws PricingException

  Processes the return from a call to evaluateTarget. A return object holds the result from the evaluation and also a boolean value indicating if further processing should stop.

  Processing should stop if a null value or false value was returned from the evaluateTarget call.

  Parameters:

  pTargetRet - result of the target evaluation

  pPricingContext - Pricing parameters where Items should be FilteredCommerceItem's

  pExtraParametersMap - any extra information that might need to be passed in

  pQualifiedItems - collection of items that are acting as qualifiers

  pQualifiedItemsDetails - map of details of the qualifying items

  pDetailsTaggedToReceiveDiscount - map of dipis tagged to receive a discount

  Returns:

  a return object containing the result of the target evaluation and a boolean indicating whether to stop processing

  Throws:

  PricingException - if an error occurred during processing

  findQualifyingObjectNoTargetEvaluation

  @Deprecated
  protected MatchingObject findQualifyingObjectNoTargetEvaluation(java.util.List pPriceQuotes,
                                                                             java.util.List pItems,
                                                                             RepositoryItem pPricingModel,
                                                                             RepositoryItem pProfile,
                                                                             java.util.Locale pLocale,
                                                                             Order pOrder,
                                                                             OrderPriceInfo pOrderPriceInfo,
                                                                             ShippingGroup pShippingGroup,
                                                                             ShippingPriceInfo pShippingPriceInfo,
                                                                             java.util.Map pExtraParametersMap,
                                                                             java.lang.Object pTarget)
                                                           throws PricingException

  Deprecated. replaced by findQualifyingObjectNoTargetEvaluation(PricingContext, Map, Object)

  This method is used by both findQualifyingOrder and findQualifyingShipping since they both use the same logic. The object that will be targetted is different in both cases. Therefore, it is passed in via the parameter pTarget. It assumes the necessary parameters are not null. (pOrder if pTarget is an order, pShippingGroup if pTarget is a shipping group

  This method will first call filterItemsForQualifier to remove items that should not be available while processing the PMDL rule. It will then call evaluateQualifier to see if the object qualifies for the given promotion (pPricingModel). It is possible evaluateQualifier will be called more than once to see if the promotion is applicable more than once. This method will never call evaluateTarget

  NOTE: because findQualifyingObject needs to tinker with a CommerceItem's quantity, input CommerceItems are wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any.

  pExtraParametersMap - any extra information that might need to be passed in.

  pTarget - The object that will be discounted if the pricing model is evaluated successfully

  Returns:

  a MatchingObject object which specifies the object that should be discounted, if any

  Throws:

  PricingException

  See Also:

  filterItemsForQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.util.Map, java.util.List, java.util.List), evaluateQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map)

  findQualifyingObjectNoTargetEvaluation

  protected MatchingObject findQualifyingObjectNoTargetEvaluation(PricingContext pPricingContext,
                                                                  java.util.Map pExtraParametersMap,
                                                                  java.lang.Object pTarget)
                                                           throws PricingException

  This method is used by both findQualifyingOrder and findQualifyingShipping since they both use the same logic. The object that will be targeted is different in both cases. Therefore, it is passed in via the parameter pTarget. It assumes the necessary parameters are not null. (pOrder if pTarget is an order, pShippingGroup if pTarget is a shipping group

  This method will first call filterItemsForQualifier to remove items that should not be available while processing the PMDL rule. It will then call evaluateQualifier to see if the object qualifies for the given promotion (pPricingModel). It is possible evaluateQualifier will be called more than once to see if the promotion is applicable more than once. This method will never call evaluateTarget

  NOTE: because findQualifyingObject needs to tinker with a CommerceItem's quantity, input pricingContext CommerceItems must be wrapped inside FilteredCommerceItems. Any code which extends Qualifier functionality can access the original input item at any time by referencing the wrappedItem property of the wrapper FilteredCommerceItem.

  Parameters:

  pPricingContext - Pricing parameters

  pExtraParametersMap - any extra information that might need to be passed in.

  pTarget - The object that will be discounted if the pricing model is evaluated successfully

  Returns:

  a MatchingObject object which specifies the object that should be discounted, if any

  Throws:

  PricingException

  See Also:

  filterItemsForQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map, java.util.Map, java.util.List, java.util.List), evaluateQualifier(java.util.List, java.util.List, atg.repository.RepositoryItem, atg.repository.RepositoryItem, java.util.Locale, atg.commerce.order.Order, atg.commerce.pricing.OrderPriceInfo, atg.commerce.order.ShippingGroup, atg.commerce.pricing.ShippingPriceInfo, java.util.Map)

  tagDetailsAsDiscounted

  protected java.util.Map tagDetailsAsDiscounted(ItemPriceInfo pItemPrice,
                                                 FilteredCommerceItem pItem,
                                                 long pMatchingQuantity,
                                                 QualifiedItem pQualifiedItem,
                                                 java.util.Map pDetailsTaggedToReceiveDiscount)

  This method will cycle through the qualified item targeted by the pricing model and marks the correct details as discounted. This will allow the filters for targeting to work properly and also updates the qualifying details map the calculator will use.

  Parameters:

  pItemPrice - The ItemPriceInfo for the given item

  pItem - A FilteredCommerceItem that was "matched" during target evaluation

  pMatchingQuantity - The quantity of pItem that match

  pQualifiedItem - The QualifiedItem for pItem

  pDetailsTaggedToReceiveDiscount - A Map from DetailedItemPriceInfos to ranges that identify what specifically will receive a discount

  Returns:

  a map where the keys are DetailedItemPriceInfos, and the values are Lists of Ranges

  evaluateQualifier

  @Deprecated
  protected java.lang.Object evaluateQualifier(java.util.List pPriceQuotes,
                                                          java.util.List pItems,
                                                          RepositoryItem pPricingModel,
                                                          RepositoryItem pProfile,
                                                          java.util.Locale pLocale,
                                                          Order pOrder,
                                                          OrderPriceInfo pOrderPriceInfo,
                                                          ShippingGroup pShippingGroup,
                                                          ShippingPriceInfo pShippingPriceInfo,
                                                          java.util.Map pExtraParametersMap)
                                        throws PricingException

  Deprecated. replaced by evaluateQualifier(PricingContext, Map, List)

  evaluates the qualifier of a cached PMDL rule. The rule is contained as a property of pPricingModel. It is extracted and evaluated.
  The first thing this method does is validate the incoming parameters. (Make sure the required parameters are not null.)

  We then get the appropriate pricing model from the pricing model cache.

  Next, it remembers the original price info values. These price infos may be manipulated during the coures of evaluation. We need to make sure they get reset to the proper values.

  Next, call createPMDLBindings

  evaluate the target

  Restore the price infos

  return the result. If there's a current working price associated with one of these items, the working price becomes the current price.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  either a Boolean object, or a List of objects which satisfy the rule. The objects that satisfy the rule are represented with MatchingObjects

  Throws:

  PricingException

  See Also:

  #validateEvaluationParams, createPMDLBindings(java.util.List, atg.repository.RepositoryItem, atg.commerce.order.Order, atg.commerce.order.ShippingGroup, java.util.Locale, java.util.Map), atg.commerce.pricing.PMDLCache, MatchingObject

  evaluateQualifier

  protected java.lang.Object evaluateQualifier(PricingContext pPricingContext,
                                               java.util.Map pExtraParametersMap,
                                               java.util.List pFilteredQualifierItems)
                                        throws PricingException

  evaluates the qualifier of a cached PMDL rule. The rule is contained as a property of pPricingModel. It is extracted and evaluated.
  The first thing this method does is validate the incoming parameters. (Make sure the required parameters are not null.)

  We then get the appropriate pricing model from the pricing model cache.

  Next, it remembers the original price info values. These price infos may be manipulated during the coures of evaluation. We need to make sure they get reset to the proper values.

  Next, call createPMDLBindings

  evaluate the target

  Restore the price infos

  return the result. If there's a current working price associated with one of these items, the working price becomes the current price.

  Parameters:

  pPricingContext - PricingContext for this evaluation

  pExtraParametersMap - Map of extra parameters

  pFilteredQualifierItems - List of FilteredCommerceItem to evaluate against

  Returns:

  either a Boolean object, or a List of objects which satisfy the rule. The objects that satisfy the rule are represented with MatchingObjects

  Throws:

  PricingException

  See Also:

  #validateEvaluationParams, createPMDLBindings(java.util.List, atg.repository.RepositoryItem, atg.commerce.order.Order, atg.commerce.order.ShippingGroup, java.util.Locale, java.util.Map), atg.commerce.pricing.PMDLCache, MatchingObject

  evaluateTarget

  @Deprecated
  protected java.lang.Object evaluateTarget(java.util.List pPriceQuotes,
                                                       java.util.List pItems,
                                                       RepositoryItem pPricingModel,
                                                       RepositoryItem pProfile,
                                                       java.util.Locale pLocale,
                                                       Order pOrder,
                                                       OrderPriceInfo pOrderPriceInfo,
                                                       ShippingGroup pShippingGroup,
                                                       ShippingPriceInfo pShippingPriceInfo,
                                                       java.util.Map pExtraParametersMap)
                                     throws PricingException

  Deprecated. replaced by evaluateTarget(PricingContext, Map, List)

  evaluates the target of a cached PMDL rule. The rule is contained as a property of pPricingModel. It is extracted and evaluated.
  The first thing this method does is validate the incoming parameters. (Make sure the required parameters are not null.)

  We then get the appropriate pricing model from the pricing model cache.

  Next, it remembers the remembers the original price info values. These price infos may be manipulated during the coures of evaluation. We need to make sure they get reset to the proper values.

  Next, call createPMDLBindings

  evaluate the target

  Restore the price infos

  return the result. If there's a current working price associated with one of these items, the working price becomes the current price.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  either a Boolean object, or a List of objects which satisfy the rule. The objects that satisfy the rule are represented with MatchingObjects

  Throws:

  PricingException

  See Also:

  #validateEvaluationParams, createPMDLBindings(java.util.List, atg.repository.RepositoryItem, atg.commerce.order.Order, atg.commerce.order.ShippingGroup, java.util.Locale, java.util.Map), atg.commerce.pricing.PMDLCache, MatchingObject

  evaluateTarget

  protected java.lang.Object evaluateTarget(PricingContext pPricingContext,
                                            java.util.Map pExtraParametersMap,
                                            java.util.List pFilteredTargetItems)
                                     throws PricingException

  evaluates the target of a cached PMDL rule. The rule is contained as a property of pPricingModel. It is extracted and evaluated.
  The first thing this method does is validate the incoming parameters. (Make sure the required parameters are not null.)

  We then get the appropriate pricing model from the pricing model cache.

  Next, it remembers the remembers the original price info values. These price infos may be manipulated during the coures of evaluation. We need to make sure they get reset to the proper values.

  Next, call createPMDLBindings

  evaluate the target

  Restore the price infos

  return the result. If there's a current working price associated with one of these items, the working price becomes the current price.

  Parameters:

  pPricingContext - PricingContext to evaluate

  pExtraParametersMap - Map of extra parameters

  pFilteredTargetItems - List of FilteredCommerceItem to evaluate against

  Returns:

  either a Boolean object, or a List of objects which satisfy the rule. The objects that satisfy the rule are represented with MatchingObjects

  Throws:

  PricingException

  See Also:

  #validateEvaluationParams, createPMDLBindings(java.util.List, atg.repository.RepositoryItem, atg.commerce.order.Order, atg.commerce.order.ShippingGroup, java.util.Locale, java.util.Map), atg.commerce.pricing.PMDLCache, MatchingObject

  checkTargetPricesLessThanOrEqualToPromotionPrice

  @Deprecated
  protected DiscountStructure checkTargetPricesLessThanOrEqualToPromotionPrice(java.util.List<DiscountStructure> pDiscountStructures)

  Deprecated. as of release 10.2 in order to support promotion filter flag overrides

  Utility method to decide if we need to check items for filtering against prices less than or equal to the promotion price. Only for new pmdl version 2+ since for version 1 we will filter out before evaluating the target. If filter flag is set and any of the passed in discounts are fixed price then we will return the cheapest fixed price discount structure.

  Parameters:

  pDiscountStructures - List to check through

  Returns:

  the fixed price DiscountStructure - if filter flag is set and discount type is fixed price and adjuster non null.

  See Also:

  checkTargetPricesLessThanOrEqualToPromotionPrice(java.util.List, PricingContext, java.util.Map)

  checkTargetPricesLessThanOrEqualToPromotionPrice

  protected DiscountStructure checkTargetPricesLessThanOrEqualToPromotionPrice(java.util.List<DiscountStructure> pDiscountStructures,
                                                                               PricingContext pPricingContext,
                                                                               java.util.Map pExtraParametersMap)

  Utility method to decide if we need to check items for filtering against prices less than or equal to the promotion price. Only for new pmdl version 2+ since for version 1 we will filter out before evaluating the target. If filter flag is set and any of the passed in discounts are fixed price then we will return the cheapest fixed price discount structure. Supports promotion filter flag overrides.

  Parameters:

  pDiscountStructures - List to check through

  pPricingContext - PricingContext to evaluate

  pExtraParametersMap - Map of extra parameters

  Returns:

  the fixed price DiscountStructure - if filter flag is set and discount type is fixed price and adjuster non null.

  deriveFilterForTargetPriceLessThanOrEqualToPromotionPrice

  protected boolean deriveFilterForTargetPriceLessThanOrEqualToPromotionPrice(PricingContext pPricingContext,
                                                                              java.util.Map pExtraParametersMap)

  Derive the correct value to use for the 'FilterForTargetPriceLessThanOrEqualToPromotionPrice' filter. If the extra parameters map is null then use the global filter value. Otherwise, retrieve any relevant promotion filter overrides.

  Parameters:

  pPricingContext - PricingContext to evaluate

  pExtraParametersMap - Map of extra parameters

  Returns:

  filterItemByPrice

  @Deprecated
  protected FilteredCommerceItem filterItemByPrice(FilteredCommerceItem pItem,
                                                              DiscountStructure pDiscountStructure)

  Deprecated. replaced by filterItemByPrice(FilteredCommerceItem,DiscountStructure, Map)

  This method will check if any of the given filtered commerce item should be filtered out because it's unit price is less than the fixed price discount. This method is only called for matching target items in a fixed price discount with a non null adjuster. If any portion of the given item needs to be filtered out then this method will create a new FilteredCommerceItem and set up its quantity and valid details map for return.

  Parameters:

  pItem - FilteredCommerceItem to check

  pDiscountStructure - DiscountStructure to check price

  Returns:

  FilteredCommerceItem to use

  filterItemByPrice

  public FilteredCommerceItem filterItemByPrice(FilteredCommerceItem pItem,
                                                DiscountStructure pDiscountStructure,
                                                java.util.Map pExtraParametersMap)

  This method will check if any of the given filtered commerce item should be filtered out because it's unit price is less than the fixed price discount. This method is only called for matching target items in a fixed price discount with a non null adjuster. If any portion of the given item needs to be filtered out then this method will create a new FilteredCommerceItem and set up its quantity and valid details map for return.

  Parameters:

  pItem - FilteredCommerceItem to check

  pDiscountStructure - DiscountStructure to check price

  pExtraParametersMap - any extra info needed to filter items

  Returns:

  FilteredCommerceItem to use

  wrapCommerceItems

  protected java.util.List wrapCommerceItems(java.util.List pItems,
                                             java.util.List pPriceQuotes)

  produce a list of FilteredCommerceItems from a list of CommerceItems

  Parameters:

  pItems - A list of CommerceItems

  pPriceQuotes - The prices of the commerce items

  Returns:

  A list of FilteredCommerceItems

  createPMDLBindings

  @Deprecated
  protected java.util.Map createPMDLBindings(java.util.List pItems,
                                                        RepositoryItem pProfile,
                                                        Order pOrder,
                                                        ShippingGroup pShippingGroup,
                                                        java.util.Locale pLocale,
                                                        java.util.Map pExtraParametersMap)

  Deprecated. replaced by createPMDLBindings(PromotionQualifyingDetails)

  Create the map of bindings that are used during evaluation of the any PMDL This will make the following bindings:

  • ITEMS_BINDING_NAME -> pItems
  • PROFILE_BINDING_NAME -> pProfile
  • ORDER_BINDING_NAME -> pOrder
  • SHIPPING_GROUP_BINDING_NAME -> pShippingGroup
  • LOCALE_BINDING_NAME -> pLocale

  Parameters:

  pItems - The list of items available to the rule

  pProfile - The users profile

  pOrder - The order that the rule applies to, if applicable

  pShippingGroup - The shipping group the rule applies to, if applicable

  pLocale - The locale that this pricing operation is for

  pExtraParametersMap - A Map of extra parameters. This is currently ignored.

  Returns:

  The Map of bindings

  createPMDLBindings

  protected java.util.Map createPMDLBindings(PricingContext pPricingContext,
                                             java.util.Map pExtraParametersMap,
                                             java.util.List pFilteredItems)

  Create the map of bindings that are used during evaluation of the any PMDL This will make the following bindings:

  • ITEMS_BINDING_NAME -> pItems
  • PROFILE_BINDING_NAME -> pProfile
  • ORDER_BINDING_NAME -> pOrder
  • SHIPPING_GROUP_BINDING_NAME -> pShippingGroup
  • LOCALE_BINDING_NAME -> pLocale

  Parameters:

  pPricingContext - PricingContext to bind

  pExtraParametersMap - Map of extra parameters to bind

  pFilteredItems - List of FilteredCommerceItem to bind

  Returns:

  The Map of bindings

  filterItems

  public void filterItems(int pFilterContext,
                          PricingContext pPricingContext,
                          java.util.Map pExtraParametersMap,
                          java.util.Map pDetailsPendingActingAsQualifier,
                          java.util.Map pDetailsRangesToReceiveDiscount,
                          java.util.List pFilteredItems)
                   throws PricingException

  Implementations should populate the filteredItems list with the appropriate items for the given filterContext. They are also responsible for updating each FilteredCommerceItem's quantity, detailsRangesValidForQualifier and detailsRangesValidForTarget properties.

  Specified by:

  filterItems in interface PromotionQualifyingFilter

  Parameters:

  pFilterContext - int context of this filtering, e.g. qualifier or target filtering

  pPricingContext - PricingContext to filter with

  pExtraParametersMap - Map of extra parameters

  pDetailsPendingActingAsQualifier - the Ranges of various DetailedItemPriceInfos that are pending for qualifying this promotion.

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pFilteredItems - output param which represents the CommerceItems not weeded out by the filter.

  Throws:

  PricingException - for problems filtering

  doFilters

  protected void doFilters(int pFilterContext,
                           PricingContext pPricingContext,
                           java.util.Map pExtraParametersMap,
                           java.util.Map pDetailsPendingActingAsQualifier,
                           java.util.Map pDetailsRangesToReceiveDiscount,
                           java.util.List pFilteredItems)
                    throws PricingException

  Loops through the configured filters to allow them to filter out items for the rule evaluations.

  Parameters:

  pFilterContext - context of this filter, e.g. qualifier or target filtering

  pPricingContext - PricingContext to use for filtering

  pExtraParametersMap - Map of extra parameters

  pDetailsPendingActingAsQualifier - the Ranges of various DetailedItemPriceInfos that are pending for qualifying this promotion.

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pFilteredItems - output param which represents the FilteredCommerceItems not weeded out by the filter.

  Throws:

  PricingException - for problems filtering items.

  filterItemsForQualifier

  @Deprecated
  protected void filterItemsForQualifier(java.util.List pPriceQuotes,
                                                    java.util.List pItems,
                                                    RepositoryItem pPricingModel,
                                                    RepositoryItem pProfile,
                                                    java.util.Locale pLocale,
                                                    Order pOrder,
                                                    OrderPriceInfo pOrderPriceInfo,
                                                    ShippingGroup pShippingGroup,
                                                    ShippingPriceInfo pShippingPriceInfo,
                                                    java.util.Map pExtraParametersMap,
                                                    java.util.Map pDetailsRangesToReceiveDiscount,
                                                    java.util.List pNewPriceInfos,
                                                    java.util.List pNewItems)
                                  throws PricingException

  Deprecated. replaced by filterItemsForQualifier(PricingContext, Map, Map, List)

  Filtering routine to remove quantities of the given items so that qualifier condition rules can be accurately evaluated. This process represents "consuming" items that should be excluded from the result set of the next rule evaluation. Each criterion is evaluated on a detailedPriceInfo scale.

  The filtering criteria are configured via the "filter" properties of this class. See class-level javadoc for description of filter properties. This method uses filters with names of the type filterForQualifier...

  The output params pNewPriceInfos and pNewItems are initialized and returned containing the filtered quantities and price infos

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the profile of the current user

  pLocale - the locale of the current pricing

  pOrder - the current order being priced

  pOrderPriceInfo - the price info of the order currently being priced

  pShippingGroup - the shipping group currently being priced

  pShippingPriceInfo - the price info of the shipping group currently being priced.

  pExtraParametersMap - any extra info needed to filter items for the qualifier

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pNewPriceInfos - output parameter which represents the ItemPriceInfos of the items that have not been weeded out by the filter.

  pNewItems - output param which represents the CommerceItems not weeded out by the filter.

  Throws:

  PricingException - if items can't be filtered from the input environment

  filterItemsForQualifier

  protected void filterItemsForQualifier(PricingContext pPricingContext,
                                         java.util.Map pExtraParametersMap,
                                         java.util.Map pDetailsRangesToReceiveDiscount,
                                         java.util.List pFilteredQualifierItems)
                                  throws PricingException

  Filtering routine to remove quantities of the given items so that qualifier condition rules can be accurately evaluated. This process represents "consuming" items that should be excluded from the binding map for the qualifier condition rule evaluation. Each criterion is evaluated on a detailedPriceInfo scale.

  The filtering criteria are configured via the "filter" properties of this class. See class-level javadoc for description of filter properties. This method uses filters with names of the type filterForQualifier...

  The output param pDetails.filteredItems is returned containing the filtered items with updated quantities Note, this method is coded to be able to handle it being the first filter as it is OOTB OR to be able to be later in the filter list.

  Parameters:

  pPricingContext - PricingContext for this promotion

  pExtraParametersMap - Map of extra parameters

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pFilteredQualifierItems - output param which represents the FilteredCommerceItems not weeded out by the filter.

  Throws:

  PricingException - if items can't be filtered from the input environment

  filterItemsForTarget

  @Deprecated
  protected void filterItemsForTarget(java.util.List pPriceQuotes,
                                                 java.util.List pItems,
                                                 RepositoryItem pPricingModel,
                                                 RepositoryItem pProfile,
                                                 java.util.Locale pLocale,
                                                 Order pOrder,
                                                 OrderPriceInfo pOrderPriceInfo,
                                                 ShippingGroup pShippingGroup,
                                                 ShippingPriceInfo pShippingPriceInfo,
                                                 java.util.Map pExtraParametersMap,
                                                 java.util.Map pDetailsPendingActingAsQualifier,
                                                 java.util.Map pDetailsRangesToReceiveDiscount,
                                                 java.util.List pNewPriceInfos,
                                                 java.util.List pNewItems)
                               throws PricingException

  Deprecated. As of ATG10, replaced by filterItemsForTarget(PromotionQualifyingDetails,Map,Map,List).

  Filtering routine to remove quantities of the given items so that target offer rules can be accurately evaluated. This process represents "consuming" items that should be excluded from the result set of the next rule evaluation. Each criterion is evaluated on a per-detailedPriceInfo basis.

  The filtering criteria are configured via the "filter" properties of this class. See class-level javadoc for description of filter properties. This method uses filters with names of the type filterForTarget...

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the profile of the current user

  pLocale - the locale of the current pricing

  pOrder - the current order being priced

  pOrderPriceInfo - the price info of the order currently being priced

  pShippingGroup - the shipping group currently being priced

  pShippingPriceInfo - the price info of the shipping group currently being priced.

  pExtraParametersMap - any extra info needed to filter items for the qualifier

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pNewPriceInfos - output parameter which represents the ItemPriceInfos of the items that have not been weeded out by the filter.

  pNewItems - output param which represents the CommerceItems not weeded out by the filter.

  Throws:

  PricingException - if items can't be filtered from the input environment

  filterItemsForTarget

  protected void filterItemsForTarget(PricingContext pPricingContext,
                                      java.util.Map pExtraParametersMap,
                                      java.util.Map pDetailsPendingActingAsQualifier,
                                      java.util.Map pDetailsRangesToReceiveDiscount,
                                      java.util.List pFilteredTargetItems)
                               throws PricingException

  Filtering routine to remove quantities of the given items so that target offer rules can be accurately evaluated. This process represents "consuming" items that should be excluded from the binding map for the target rule evaluation. Each criterion is evaluated on a per-detailedPriceInfo basis.

  The filtering criteria are configured via the "filter" properties of this class. See class-level javadoc for description of filter properties. This method uses filters with names of the type filterForTarget... Note: This method is the first filter OOTB but it can be optionally configured to be a later filter.

  Parameters:

  pPricingContext - PricingContext to use for filtering

  pExtraParametersMap - Map of extra parameters

  pDetailsPendingActingAsQualifier - the Ranges of various DetailedItemPriceInfos that are pending for qualifying this promotion.

  pDetailsRangesToReceiveDiscount - the Ranges of various DetailedItemPriceInfos that are going to receive the discount

  pFilteredTargetItems - output param which represents the CommerceItems not weeded out by the filter.

  Throws:

  PricingException - if items can't be filtered from the input environment

  filterShippingForTarget

  @Deprecated
  protected boolean filterShippingForTarget(java.util.List pPriceQuotes,
                                                       java.util.List pItems,
                                                       RepositoryItem pPricingModel,
                                                       RepositoryItem pProfile,
                                                       java.util.Locale pLocale,
                                                       Order pOrder,
                                                       OrderPriceInfo pOrderPriceInfo,
                                                       ShippingGroup pShippingGroup,
                                                       ShippingPriceInfo pShippingPriceInfo,
                                                       java.util.Map pExtraParametersMap)
                                     throws PricingException

  Deprecated. replaced by filterShippingForTarget(PricingContext,Map)

  Filtering routine that checks if the given shipping group is allowed to receive the given discount (pPricingModel). If this method returns true, then it is okay. If this method returns false, then shipping group should not receive this discount. The only check that gets made is against the pricing model's value of "oneUsePerOrder". If this is true, and the pricing model has been used on a shipping group in this order already, then return false.

  Parameters:

  pPriceQuotes - a list of prices corresponding 1:1 to the entries in pItems.

  pItems - a list of CommerceItems in the environment.

  pPricingModel - the discount whose rule is being evaluated

  pProfile - the current profile

  pLocale - the current locale

  pOrder - the current order, if any

  pOrderPriceInfo - the price of the current order, if any

  pShippingGroup - the current shipping group, if any

  pShippingPriceInfo - the price of the current shipping group, if any

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  true if it is okay for pShippingGroup to receive the discount, false otherwise

  Throws:

  PricingException

  filterShippingForTarget

  protected boolean filterShippingForTarget(PricingContext pPricingContext,
                                            java.util.Map pExtraParametersMap)
                                     throws PricingException

  Filtering routine that checks if the given shipping group is allowed to receive the given discount (pPricingModel). If this method returns true, then it is okay. If this method returns false, then shipping group should not receive this discount. The only check that gets made is against the pricing model's value of "oneUsePerOrder". If this is true, and the pricing model has been used on a shipping group in this order already, then return false.

  Parameters:

  pPricingContext - PricingContext environment

  pExtraParametersMap - any extra information that might need to be passed in.

  Returns:

  true if it is okay for pShippingGroup to receive the discount, false otherwise

  Throws:

  PricingException

  processPromotionAnalysisFilterInformation

  protected void processPromotionAnalysisFilterInformation(java.util.Map<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails,java.lang.String> pFilterDetails,
                                                           CommerceItem pCommerceItem,
                                                           java.util.List<atg.core.util.Range> pRanges,
                                                           java.lang.String pTriggerCause,
                                                           java.util.Map pExtraParametersMap)

  Helper method for promotion analysis used to process filter details.

  Parameters:

  pFilterDetails - details of already filtered items

  pCommerceItem - the item being filtered

  pRanges - a list of ranges that have been filtered

  pTriggerCause - filtering cause

  pExtraParametersMap - extra parameters

  processPromotionAnalysisFilterInformation

  protected void processPromotionAnalysisFilterInformation(java.util.Map<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails,java.lang.String> pFilterDetails,
                                                           CommerceItem pCommerceItem,
                                                           long pQuantity,
                                                           java.lang.String pTriggerCause,
                                                           java.util.Map pExtraParametersMap)

  Helper method for promotion analysis used to process filter details.

  Parameters:

  pFilterDetails - details of already filtered items

  pCommerceItem - the item being filtered

  pQuantity - the filter quantity

  pTriggerCause - filtering cause

  pExtraParametersMap - extra parameters

  processPromotionAnalysisInformation

  protected void processPromotionAnalysisInformation(PricingContext pPricingContext,
                                                     boolean pConditionEvaluatedFirst,
                                                     int pIteration,
                                                     java.util.List<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails> pQualifierItems,
                                                     java.lang.Boolean pQualifierPassed,
                                                     java.lang.Boolean pOfferPassed,
                                                     java.util.Map pExtraParametersMap)
                                              throws PricingException

  Helper method used to set condition and offer promotion analysis information in the holder object.

  Parameters:

  pPricingContext - PricingContext environment

  pConditionEvaluatedFirst - true if the condition was evaluated first, false otherwise

  pIteration - iteration number

  pQualifierItems - any qualifier items

  pQualifierPassed - indicates if the qualifier passed or failed

  pOfferPassed - indicates if the offer passed or failed

  pExtraParametersMap - any extra information that might need to be passed in

  Throws:

  PricingException - if the condition and offer information could not be processed

  processPromotionAnalysisInformation

  protected void processPromotionAnalysisInformation(PricingContext pPricingContext,
                                                     boolean pConditionEvaluatedFirst,
                                                     boolean pValidationStageExecuted,
                                                     int pIteration,
                                                     java.util.Map pExtraParametersMap)
                                              throws PricingException

  Helper method used to set condition and offer promotion analysis information in the holder object.

  Parameters:

  pPricingContext - PricingContext environment

  pConditionEvaluatedFirst - true if the condition was evaluated first, false otherwise

  pValidationStageExecuted - true if a validation stage preceded the condition/offer evaluation stage

  pIteration - iteration number

  pExtraParametersMap - any extra information that might need to be passed in

  Throws:

  PricingException - if the condition and offer information could not be processed

  markQualifierItems

  protected void markQualifierItems(java.util.List pItemsFromQualifier,
                                    java.util.Map pItemsPendingActingAsQualifier)
                             throws PricingException

  This method marks the matching objects that were returned by the evaluateQualifier method as having acted as qualifiers during this iteration. Currently this method is only called for each iteration of a 'For Next' type promotion. In 'For Next' type promotions usually if a quantity of an item has acted as a qualifier it is no longer valid to act as a qualifier for any further promotions nor can it usually act as a target to be discounted. The method updates the passed in pItemsFromQualifier FilteredCommerceItems. It updates each items QuantityAsQualifierDetails Map with the new qualifier ranges. It also updates each item's price info and each DIPI - 'QuantityAsQualifier' property.

  Parameters:

  pItemsFromQualifier - List of MatchingObject returned by evaluateQualifier

  pItemsPendingActingAsQualifier - Map of DIPI to a List of Range objects that are marked as qualifiers.

  Throws:

  PricingException - if the is a problem marking the ranges

  buildPromotionAnalysisItemDetails

  protected java.util.List<atg.commerce.promotion.PromotionAnalysisManager.ItemDetails> buildPromotionAnalysisItemDetails(java.util.List pItems,
                                                                                                                          boolean pIsQualifier)
                                                                                                                   throws PricingException

  Helper method used to convert a list of MatchingObjects into the required format for the PromotionAnalysisManager.

  Parameters:

  pItems - a list items

  pIsQualifier - true if this is a qualifier evaluation

  Returns:

  a converted list of items in PromotionAnalysisManager format

  Throws:

  PricingException - if the correct type of objects were not found in pItemsFromQualifier

  calculateItemQuantityAvailable

  protected long calculateItemQuantityAvailable(FilteredCommerceItem pItem,
                                                boolean pIsQualifier)

  Calculate the quantity of this item that is available. The pIsQualifier parameter can be used to determine if the remaining qualifying quantity or remaining target quantity should be calculated.

  Parameters:

  pItem - item to calculate quantity for

  pIsQualifier - true if quantity should be calculated for the qualifier, false for target

  Returns:

  the quantity available

  doStartService

  public void doStartService()
                      throws ServiceException

  GenericService override

  Overrides:

  doStartService in class GenericService

  Throws:

  ServiceException - if the Service had a problem starting up

  isClosenessQualifier

  protected boolean isClosenessQualifier(RepositoryItem pPricingModel)
                                  throws PricingException

  Method checks if the pricing model is a closeness qualifier.

  Parameters:

  pPricingModel - RepositoryItem pricing model to check

  Returns:

  true if the pricing model is a closeness qualifier otherwise false.

  Throws:

  PricingException - for repository exceptions.

  setExactlyPromotionLoopThrough

  public void setExactlyPromotionLoopThrough(boolean pExactlyPromotionLoopThrough)

  isExactlyPromotionLoopThrough

  public boolean isExactlyPromotionLoopThrough()

  If true, Exactly promotion will try to loop through all items in collecion. This should be the correct behaviour. But due to bug 73589-1, Exactly promtion can only look at the first item. Some customers might depend on the old/incorrect behaviour. This configurable property is introduced to switch between two behaviours. If false, Exactly promotion will only check the first item

  default value is true

  validatePromotion

  protected boolean validatePromotion(PricingContext pPricingContext,
                                      java.util.Map pExtraParameters)
                               throws PricingException

  Method to do up front validation of a promotion to determine if it isn't valid for further evaluation.
  This method should only return false if it can guarantee that the promotion could not qualify and find a valid target.
  This validation is performed on an unfiltered and unsorted list of commerce items in the cart.
  The purpose of the method is to improve performance by avoiding a full evaluation of a promotion if possible.

  Parameters:

  pPricingContext - PricingContext with the promotion and commerce items to validate

  pExtraParameters - Map of extra parameters, must not be null

  Returns:

  false only if the promotion is guaranteed to not qualify and find a valid target, otherwise it should return true.

  Throws:

  PricingException - for problems during the validation

  getGlobalFilters

  public java.util.Map<java.lang.String,java.lang.Boolean> getGlobalFilters()

  Returns a map of the global filters.

  Returns:

  a map of the global filters

  getPromotionFilters

  protected java.util.Map<java.lang.String,java.lang.Boolean> getPromotionFilters(RepositoryItem pPricingModel)

  Returns a map of the promotion filters. A promotion filter map is created by merging promotion overrides with a base set of global flags.

  Parameters:

  pPricingModel - the pricing model

  Returns:

  a mpa of promotion filters