atg.projects.store.pricing

Class StorePricingTools

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.dms.forward.SourceSinkTemplate

atg.commerce.messaging.SourceSinkTemplate

atg.commerce.pricing.PricingTools

atg.projects.store.pricing.StorePricingTools

All Implemented Interfaces:

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

public class StorePricingTools
extends atg.commerce.pricing.PricingTools

Store extension for the PricingTools.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/EStore/src/atg/projects/store/pricing/StorePricingTools.java#1 $$Change: 1385662 $

Author:

ATG

See Also:

PricingTools

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.
protected atg.commerce.promotion.GWPManager	mGwpManager Manager component for gift with purchase promotions
static java.lang.String	SKIP_STACKING_RULES_MESSAGES_SENDING

Fields inherited from class atg.commerce.pricing.PricingTools

ALL_BY_GROUP, DEFAULT_DECIMAL_PLACES, DETAILED_ITEM_PRICE_AMOUNT_PROPERTY, DETAILED_ITEM_PRICE_ORDER_DISCOUNT_SHARE_PROPERTY, DETAILED_ITEM_PRICE_ORDER_MANUAL_ADJUSTMENT_SHARE_PROPERTY, ERR_CANNOT_GET_PROD_ITEM, ERR_CANNOT_PARSE_DECIMAL_PLACES_NUMBER, ERR_CANT_GET_PRICE_FOR_PROD, ERR_CANT_SEND_MESSAGE, ERR_PASSED_NULL_PRICE_INFO, ERR_PRICELIST_REQUIRED, ERR_PRICELISTMANAGER_NOT_CONFIGURED, ERR_PRODUCT_REQUIRED, ERR_PROFILE_REQUIRED, ERR_PROMOTION_ANALYSIS_MODEL_HOLDER_NOT_FOUND, ERR_SKU_REQUIRED, GROUP_INDEX, GROUP_ONLY, GROUP_PRICING_MODEL, INF_MSG_NULL_PROFILE, LIST_PRICE, LIST_VOLUME_PRICE, mItemPriceSourceHandlers, mUsingPriceLists, MY_RESOURCE_NAME, ON_SALE, PRICE_MAX, PRICE_MIN, PRICE_RANGE, PRICING_TOOLS_COMPONENT_PATH, SALE_PRICE, SALE_VOLUME_PRICE, SKU_PRICES, SKUID, sPricingTools, WRN_NO_PRICELIST_FOR_LOCALE, WRN_PARAMS_INVALID_PRICELIST, WRN_PARAMS_INVALID_PRICELIST_NAME

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
StorePricingTools()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<StoreUnitPriceBean>>	generatePriceBeans(atg.commerce.order.Order pOrder) Generates a Map of unit price beans for all items in the order.
java.util.List<StoreUnitPriceBean>	generatePriceBeans(atg.commerce.order.Order pOrder, atg.commerce.order.CommerceItem pItem) Generate GWP aware price beans for the given commerce item.
java.util.List<StoreUnitPriceBean>	generatePriceBeans(atg.commerce.order.Order pOrder, atg.commerce.order.CommerceItem pItem, java.util.List<atg.commerce.pricing.DetailedItemPriceInfo> pInfos) Generate GWP aware price beans for the given commerce item and list of price infos.
atg.commerce.promotion.GWPManager	getGwpManager() Getter for the gift with purchase manager property.
void	populatePriceBeanSelections(StoreUnitPriceBean pPriceBean, java.util.Collection<atg.commerce.promotion.GiftWithPurchaseSelection> pGwpSelections) Populates price bean's GwpSelections list.
void	setGwpManager(atg.commerce.promotion.GWPManager pGwpManager) Setter for the gift with purchase manager property.

Methods inherited from class atg.commerce.pricing.PricingTools

addBypassPromotionVetoersParameter, addDisableAutoGWPParameter, addDisableGWPMessaging, addDisableMaxCouponsPerOrderProcessingParameter, addDisableStackingRuleProcessingParameter, addDiscountableMapParameter, addItemPriceSourceParameter, addPriceBean, addPriceBeanForInfo, calculateItemsOrderManualAdjustmentShare, calculatePrice, calculatePrice, calculatePrice, calculatePrice, calculatePrice, calculatePrice, calculateTaxableAmount, calculateTaxableAmount, calculateTaxableAmountByAverage, calculateTaxableAmountByAverage, clearMessageTools, clearPromotionAnalysisData, compareClosenessQualifiers, compareQualifiers, createDetailedItemPriceInfo, createDetailedItemPriceInfo, createInitialSubSkuDetailedPriceInfo, createItemPriceSource, createItemPriceSource, createOrderPriceInfo, createPriceChangedEvent, createPricingCommerceItem, createPricingCommerceItem, createPricingCommerceItem, createPricingCommerceItem, createSubSkuPriceInfo, createUncachedPricingCommerceItem, deriveUsingPriceLists, doesOrderContainPriceLists, doStartService, findAdjustmentsByDescription, findHighestPrice, findMatchingSource, firePromotionClosenessMessage, generateItemPriceSources, generateItemPriceSources, generateItemPricingSourceMap, generateKeyForTieredProcessedItem, generateOrderedPriceBeans, generatePriceBeans, generatePriceBeans, generatePriceBeans, generatePriceListPrices, getAppliedPromotionsForUnprocessedEngines, getAverageItemPrice, getCatalogTools, getChildSKUsPropertyName, getClosenessQualificationMessageSender, getCommerceItemManager, getCommercePropertyManager, getCurrencyCode, getCurrencyCode, getCurrencyCodeDecimalPlacesOverrides, getCurrencySymbol, getCurrencySymbol, getDecimalFormatSymbols, getDecimalFormatSymbols, getDefaultLocale, getDefaultNumberOfDecimalPlaces, getDetailedItemPriceInfoClass, getDetailedItemPriceTools, getDiscountableMap, getDiscountablePropertyName, getFirstGroupingAdjustment, getHighestPrice, getHighestPriceItem, getInternationalCurrencySymbol, getInternationalCurrencySymbol, getItemPriceSource, getItemPriceSourceHandlers, getItemPricingEngine, getItemsOrderDiscountShare, getListPriceListFromOrder, getLocale, getLocaleFromPriceList, getLoggingIdentifier, getLowestPrice, getMaxCouponsPerOrder, getMessageIdGenerator, getMessageIdSpaceName, getMessageTools, getNextMessageId, getNumberDecimalPlacesForCurrency, getNumberDecimalPlacesForCurrency, getOrderManager, getOrderPricingEngine, getOrderTools, getPriceFromItem, getPriceFromItem, getPriceFromItem, getPriceFromItem, getPriceFromItem, getPriceFromItem, getPriceList, getPriceListFromParameters, getPriceListManager, getPriceRange, getPrices, getPrices, getPricingContextFactory, getPricingLocale, getPricingMessages, getPricingTools, getProfile, getProfileItemType, getProfileRepository, getPromotionAnalysisManager, getPromotionAnalysisModelHolderPath, getPromotionClosenessDisqualificationJMSType, getPromotionClosenessQualificationJMSType, getRangeClassType, getRangeComparator, getRelationshipsSubtotal, getRestrictedPricingOperation, getRestrictedPricingOperations, getRoundingDecimalPlaces, getSalePriceListFromOrder, getScenarioEventPort, getShipItemRelPriceTotal, getShippingGroupCommerceItemRelationship, getShippingPricingEngine, getSubSkuPriceInfoClass, getTaxPricingEngine, getTotalQuantityForBulkPricing, getTotalQuantityWithFractionForBulkPricing, getUnprocessedPricingEngines, isDiscountableItem, isDiscountableItem, isGeneratePriceChangedEvents, isGeneratePromotionAnalysisInfo, isMatchForBulkPricing, isOrderRestrictedForPricing, isSendEventsWithNoProfile, isSendGWPMessages, isSendMaxNoOfCouponsPerOrderMessages, isSendPricingMessages, isSendPromotionClosenessMessages, isSendStackingRuleMessages, isSendUserMessages, isShippingSubtotalUsesAverageItemPrice, isTaxable, isUseDefaultLocaleIfNotSpecified, isUsePassedLocaleAsPricingLocale, isUsingPriceLists, isUsingPriceListsExplicitlySet, needsRounding, needsRounding, needsRounding, performPricingOperation, postPricingOperation, prepareForMaxCouponsPerOrderLimit, prePricingOperation, priceEachItem, priceEachItem, priceEachItem, priceEachItem, priceItem, priceItem, priceItem, priceItem, priceItemsForOrderTotal, priceItemsForOrderTotal, priceItemsForOrderTotal, priceItemsForOrderTotal, priceOrderForOrderTotal, priceOrderForOrderTotal, priceOrderForOrderTotal, priceOrderForOrderTotal, priceOrderSubtotal, priceOrderSubtotal, priceOrderSubtotal, priceOrderSubtotalShipping, priceOrderSubtotalShipping, priceOrderSubtotalShipping, priceOrderSubtotalTax, priceOrderSubtotalTax, priceOrderSubtotalTax, priceOrderTotal, priceOrderTotal, priceOrderTotal, priceOrderTotal, priceOrderTotal, priceShippingForOrderTotal, priceShippingForOrderTotal, priceShippingForOrderTotal, priceShippingForOrderTotal, priceTaxForOrderTotal, priceTaxForOrderTotal, priceTaxForOrderTotal, priceTaxForOrderTotal, recreateInitialDetailsForItemMarkedAsFinal, resolvePromotionAnalysisModelHolderComponent, retrieveHighestChildSKUPrice, retrieveHighestPriceListPrice, retrieveLowestChildSKUPrice, retrieveLowestPriceListPrice, round, round, round, round, roundDown, roundDown, roundDown, roundDown, sendMaxNoOfCouponsPerOrderMessages, sendPriceChangedEvent, sendPricingMessage, sendPromotionClosenessQualificationMessage, sendStackingRuleMessages, sendUserMessage, setCatalogTools, setChildSKUsPropertyName, setClosenessQualificationMessageSender, setCommerceItemManager, setCommercePropertyManager, setCurrencyCodeDecimalPlacesOverrides, setDefaultLocale, setDetailedItemPriceInfoClass, setDiscountablePropertyName, setGeneratePriceChangedEvents, setGeneratePromotionAnalysisInfo, setItemPriceSourceHandlers, setItemPricingEngine, setLoggingIdentifier, setMaxCouponsPerOrder, setMessageIdGenerator, setMessageIdSpaceName, setMessageTools, setOrderManager, setOrderPricingEngine, setOrderTools, setPriceListManager, setPricingContextFactory, setProfileItemType, setProfileRepository, setPromotionAnalysisManager, setPromotionAnalysisModelHolderPath, setPromotionClosenessDisqualificationJMSType, setPromotionClosenessQualificationJMSType, setRangeClassType, setRangeComparator, setRestrictedPricingOperations, setRoundingDecimalPlaces, setScenarioEventPort, setSendEventsWithNoProfile, setSendGWPMessages, setSendMaxNoOfCouponsPerOrderMessages, setSendPricingMessages, setSendPromotionClosenessMessages, setSendStackingRuleMessages, setSendUserMessages, setShippingPricingEngine, setShippingSubtotalUsesAverageItemPrice, setSubSkuPrice, setSubSkuPriceInfoClass, setSubSkuSalePrice, setTaxPricingEngine, setUseDefaultLocaleIfNotSpecified, setUsePassedLocaleAsPricingLocale, setUsingPriceLists, startService

Methods inherited from class atg.commerce.messaging.SourceSinkTemplate

receiveMessage, sendCommerceMessage

Methods inherited from class atg.dms.forward.SourceSinkTemplate

beforeSendMessage, getDefaultMessageSourceName, getDelayOnSendRetry, getLimboDeliveryDelay, getMessageSourceContext, getMessageSourceName, getTransactionManager, isAllowMessageSending, sendObjectMessage, setAllowMessageSending, setDelayOnSendRetry, setLimboDeliveryDelay, setMessageSourceContext, setMessageSourceName, setTransactionManager, startMessageSource, stopMessageSource

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, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

SKIP_STACKING_RULES_MESSAGES_SENDING

public static java.lang.String SKIP_STACKING_RULES_MESSAGES_SENDING

mGwpManager

protected atg.commerce.promotion.GWPManager mGwpManager

Manager component for gift with purchase promotions

Constructor Detail

StorePricingTools

public StorePricingTools()

Method Detail

setGwpManager

public void setGwpManager(atg.commerce.promotion.GWPManager pGwpManager)

Setter for the gift with purchase manager property.

Overrides:

setGwpManager in class atg.commerce.pricing.PricingTools

Parameters:

pGwpManager - GWPManager

getGwpManager

public atg.commerce.promotion.GWPManager getGwpManager()

Getter for the gift with purchase manager property.

Overrides:

getGwpManager in class atg.commerce.pricing.PricingTools

Returns:

GWPManager

generatePriceBeans

public java.util.Map<java.lang.String,java.util.List<StoreUnitPriceBean>> generatePriceBeans(atg.commerce.order.Order pOrder)

Generates a Map of unit price beans for all items in the order. the key to the map is the commerce item id. Each value in the map is a list of UnitPriceBeans.

Parameters:

pOrder - - the order to process.

Returns:

map of unit price beans.

generatePriceBeans

public java.util.List<StoreUnitPriceBean> generatePriceBeans(atg.commerce.order.Order pOrder,
                                                             atg.commerce.order.CommerceItem pItem)

Generate GWP aware price beans for the given commerce item.

Parameters:

pOrder - The order commerce item belongs to.

pItem - The commerce item to generate price beans for.

Returns:

The list of GWP aware price beans for the given commerce item and price infos.

generatePriceBeans

public java.util.List<StoreUnitPriceBean> generatePriceBeans(atg.commerce.order.Order pOrder,
                                                             atg.commerce.order.CommerceItem pItem,
                                                             java.util.List<atg.commerce.pricing.DetailedItemPriceInfo> pInfos)

Generate GWP aware price beans for the given commerce item and list of price infos.

Parameters:

pOrder - The order commerce item belongs to.

pItem - The commerce item to generate price beans for.

pInfos - The list of detailed price infos to generate prcie beans for.

Returns:

The list of GWP aware price beans for the given commerce item and price infos.

populatePriceBeanSelections

public void populatePriceBeanSelections(StoreUnitPriceBean pPriceBean,
                                        java.util.Collection<atg.commerce.promotion.GiftWithPurchaseSelection> pGwpSelections)

Populates price bean's GwpSelections list. The method compares passed in commerce item's GWP selections within price bean's pricing models. If matching selections are found they are added to the price bean's GwpSelections list.

Parameters:

pPriceBean - The price bean to populate list of GWP selections for.

pGwpSelections - The list of GWP selections for the price bean's commerce item.