atg.commerce.order.processor

Class ProcSavePriceInfoObjects

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.SavedProperties

atg.commerce.order.processor.ProcSavePriceInfoObjects

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcSavePriceInfoObjects
extends SavedProperties
implements PipelineProcessor

This processor saves the PriceInfo objects into the OrderRepository from the Order, CommerceItem and ShippingGroup objects.

See Also:

AmountInfo, OrderPriceInfo, ItemPriceInfo, ShippingPriceInfo, TaxPriceInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL The possible "saveModes" for saving the PriceInfo objects: ALL - Saves all PriceInfo objects associated with the order.
static java.lang.String	ALL_NO_AUDIT
static java.lang.String	CLASS_VERSION Class version string
protected boolean	mVerifiedSaveModes
static java.lang.String	NONE
static java.lang.String	ORDER
static java.lang.String	ORDER_NO_AUDIT
protected static java.lang.String[]	VALID_SAVE_MODES

Fields inherited from class atg.commerce.order.processor.SavedProperties

ORDER_PROPERTY, TYPE_PROPERTY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProperties(Order order, java.lang.String[] propertyList, java.lang.Object obj, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager)
java.lang.String	getAdjustmentsProperty() Returns the adjustmentsProperty
java.lang.String	getCurrentPriceDetailsProperty() Returns the currentPriceDetailsProperty
java.lang.String	getDefaultSaveMode() The saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes
java.lang.String	getDetailedItemPriceInfoDescName() Returns the detailedItemPriceInfoDescName
java.lang.String[]	getDetailedItemPriceInfoProperties() Returns the detailedItemPriceInfoProperties
java.lang.String[]	getDetailsRangeProperties() The list of properties from the DetailedItemPriceInfo's Range property that are stored in the details repository item
java.lang.String	getItemPriceInfoProperty() Returns the itemPriceInfoProperty
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getNonTaxableShippingItemsSubtotalPriceInfosProperty() Returns property nonTaxableShippingItemsSubtotalPriceInfosProperty
java.lang.String	getOrderPriceInfoDescName() Returns property orderPriceInfoDescName
java.lang.String	getOrderPriceInfoProperty() Returns the orderPriceInfoProperty
java.util.Map	getOrderStateSaveModes() Mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state.
java.lang.String	getPricingAdjustmentDescName() Returns the pricingAdjustmentDescName
java.lang.String[]	getPricingAdjustmentProperties() Returns the pricingAdjustmentProperties
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
boolean	getSavePriceInfosInIncompleteOrders() Deprecated. Use orderStateSaveModes instead
java.lang.String	getShippingItemsSubtotalPriceInfosProperty() Returns property ShippingItemsSubtotalPriceInfosProperty
java.lang.String	getShippingItemsTaxPriceInfosProperty() Returns property ShippingItemsTaxPriceInfosProperty
java.lang.String	getShippingPriceInfoProperty() Returns the shippingPriceInfoProperty
java.lang.String	getTaxableShippingItemsSubtotalPriceInfosProperty() Returns property TaxableShippingItemsSubtotalPriceInfosProperty
java.lang.String	getTaxPriceInfoDescName() Returns property taxPriceInfoDescName
java.lang.String	getTaxPriceInfoProperty() Returns the taxPriceInfoProperty
boolean	isSaveOrderPriceInfo(java.lang.String pOrderState) Returns true if the order price info will be saved for the given order state.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method saves the PriceInfo objects into the OrderRepository from the Order, CommerceItem, and ShippingGroup objects.
protected void	saveDetailedItemPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method saves a List of DetailedItemPriceInfo objects in an ItemPriceInfo.
protected void	saveDetailedRange(Order pOrder, DetailedItemPriceInfo pDetail, MutableRepositoryItem pDetMutItem, MutableRepository pMutRep, OrderManager pOrderManager) Save the range property in a detailed item price info See the detailsRangeProperties for a list of properties that are copied
protected void	saveItemPriceInfo(Order order, CommerceItem cItem, MutableRepositoryItem cItemRepItem, MutableRepository mutRep, OrderManager orderManager) This method saves an ItemPriceInfo object.
protected void	saveNonTaxableShippingItemsSubtotalPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method is a pass through to the saveSubtotalPriceInfos method.
protected void	saveOrderPriceInfo(Order order, MutableRepositoryItem orderRepItem, MutableRepository mutRep, OrderManager orderManager) This method saves the OrderPriceInfo object in the Order class.
protected MutableRepositoryItem	savePriceInfo(Order order, CommerceIdentifier ci, MutableRepositoryItem piRepItem, java.lang.String repItemPropName, AmountInfo pPriceInfo, MutableRepository mutRep, OrderManager orderManager) This method saves an individual PriceInfo object.
protected void	savePricingAdjustments(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method saves a List of PricingAdjustment objects in an AmountInfo.
protected void	saveShippingItemsSubtotalPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method is a pass through to the saveSubtotalPriceInfos method.
protected void	saveShippingItemsTaxPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method saves a Map of ShippingItemsTaxPriceInfos objects into the repository See the savedProperties for a list of properties that are copied
protected void	saveShippingPriceInfo(Order order, ShippingGroup group, MutableRepositoryItem groupRepItem, MutableRepository mutRep, OrderManager orderManager) This method saves a ShippingPriceInfo object.
protected void	saveSubSkuPriceInfo(Order order, CommerceItem cItem, MutableRepositoryItem configRepItem, MutableRepository mutRep, OrderManager orderManager) This method saves ItemPriceInfo objects for skus of a configurable sku.
protected void	saveSubtotalPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager, java.lang.String pPropertyName) This method saves a Map of (shipping group -> price info) objects into the repository See the savedProperties for a list of properties that are copied
protected void	saveTaxableShippingItemsSubtotalPriceInfos(Order order, AmountInfo pPriceInfo, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method is a pass through to the saveSubtotalPriceInfos method.
protected void	saveTaxPriceInfo(Order order, MutableRepositoryItem orderRepItem, MutableRepository mutRep, OrderManager orderManager) This method saves the TaxPriceInfo object in the Order class.
void	setAdjustmentsProperty(java.lang.String pAdjustmentsProperty) Sets the adjustmentsProperty
void	setCurrentPriceDetailsProperty(java.lang.String pCurrentPriceDetailsProperty) Sets the currentPriceDetailsProperty
void	setDefaultSaveMode(java.lang.String pDefaultSaveMode) The saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes
void	setDetailedItemPriceInfoDescName(java.lang.String pDetailedItemPriceInfoDescName) Sets the detailedItemPriceInfoDescName
void	setDetailedItemPriceInfoProperties(java.lang.String[] pDetailedItemPriceInfoProperties) Sets the detailedItemPriceInfoProperties
void	setDetailsRangeProperties(java.lang.String[] pDetailsRangeProperties)
void	setItemPriceInfoProperty(java.lang.String pItemPriceInfoProperty) Sets the itemPriceInfoProperty
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setNonTaxableShippingItemsSubtotalPriceInfosProperty(java.lang.String pNonTaxableShippingItemsSubtotalPriceInfosProperty) Sets property NonTaxableShippingItemsSubtotalPriceInfosProperty
void	setOrderPriceInfoDescName(java.lang.String pOrderPriceInfoDescName) Sets property orderPriceInfoDescName
void	setOrderPriceInfoProperty(java.lang.String pOrderPriceInfoProperty) Sets the orderPriceInfoProperty
void	setOrderStateSaveModes(java.util.Map pOrderStateSaveModes) Mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state.
void	setPricingAdjustmentDescName(java.lang.String pPricingAdjustmentDescName) Sets the pricingAdjustmentDescName
void	setPricingAdjustmentProperties(java.lang.String[] pPricingAdjustmentProperties) Sets the pricingAdjustmentProperties
void	setSavePriceInfosInIncompleteOrders(boolean pSavePriceInfosInIncompleteOrders) Deprecated. Use orderStateSaveModes instead
void	setShippingItemsSubtotalPriceInfosProperty(java.lang.String pShippingItemsSubtotalPriceInfosProperty) Sets property ShippingItemsSubtotalPriceInfosProperty
void	setShippingItemsTaxPriceInfosProperty(java.lang.String pShippingItemsTaxPriceInfosProperty) Sets property ShippingItemsTaxPriceInfosProperty
void	setShippingPriceInfoProperty(java.lang.String pShippingPriceInfoProperty) Sets the shippingPriceInfoProperty
void	setTaxableShippingItemsSubtotalPriceInfosProperty(java.lang.String pTaxableShippingItemsSubtotalPriceInfosProperty) Sets property TaxableShippingItemsSubtotalPriceInfosProperty
void	setTaxPriceInfoDescName(java.lang.String pTaxPriceInfoDescName) Sets property taxPriceInfoDescName
void	setTaxPriceInfoProperty(java.lang.String pTaxPriceInfoProperty) Sets the taxPriceInfoProperty
protected void	verifySaveModes() Verify that each of the saveModes in orderStateSaveModes, and defaultSaveMode, are valid saveModes
protected void	writeItemToRepository(Order order, MutableRepository mutRep, MutableRepositoryItem mutItem) Update a given repository with the item passed in.
protected void	writeProperties(Order pOrder, java.util.Map<java.lang.String[],java.lang.Object> pPropertyListToSourceObject, MutableRepositoryItem pItemToCopyTo, MutableRepository pMutRep, OrderManager pOrderManager) This method saves a List of properties to a repository item, allowing for more than one source object.
protected void	writeProperties(Order order, java.lang.String[] propertyList, java.lang.Object obj, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager) This method saves a List of properties to a repository item.

Methods inherited from class atg.commerce.order.processor.SavedProperties

getMappedPropertyName, getPropertyDescriptorToBeanPropertyMap, getSaveChangedPropertiesOnly, getSavedProperties, setPropertyDescriptorToBeanPropertyMap, setSaveChangedPropertiesOnly, setSavedProperties

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning

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

Class version string

ALL

public static final java.lang.String ALL

The possible "saveModes" for saving the PriceInfo objects: ALL - Saves all PriceInfo objects associated with the order. ALL_NO_AUDIT - Saves all PriceInfo objects associated with the order, but does not save the audit trail information associated with those PriceInfos. Audit trail information includes PricingAdjustments and DetailedItemPriceInfos ORDER - Saves only the OrderPriceInfo object (no ItemPriceInfos, ShippingPriceInfos, or TaxPriceInfos) ORDER_NO_AUDIT - Saves only the OrderPriceInfo object, and does not save the audit trail information associated with that object NONE - Saves no PriceInfo objects

See Also:

Constant Field Values

ALL_NO_AUDIT

public static final java.lang.String ALL_NO_AUDIT

See Also:

Constant Field Values

ORDER

public static final java.lang.String ORDER

See Also:

Constant Field Values

ORDER_NO_AUDIT

public static final java.lang.String ORDER_NO_AUDIT

See Also:

Constant Field Values

NONE

public static final java.lang.String NONE

See Also:

Constant Field Values

VALID_SAVE_MODES

protected static final java.lang.String[] VALID_SAVE_MODES

mVerifiedSaveModes

protected boolean mVerifiedSaveModes

Constructor Detail

ProcSavePriceInfoObjects

public ProcSavePriceInfoObjects()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an integer array of the valid return codes.

getSavePriceInfosInIncompleteOrders

public boolean getSavePriceInfosInIncompleteOrders()

Deprecated. Use orderStateSaveModes instead

Returns property savePriceInfosInIncompleteOrders

Returns:

returns property savePriceInfosInIncompleteOrders

setSavePriceInfosInIncompleteOrders

public void setSavePriceInfosInIncompleteOrders(boolean pSavePriceInfosInIncompleteOrders)

Deprecated. Use orderStateSaveModes instead

Sets property savePriceInfosInIncompleteOrders

Parameters:

pSavePriceInfosInIncompleteOrders - the value to set for property savePriceInfosInIncompleteOrders

getOrderStateSaveModes

public java.util.Map getOrderStateSaveModes()

Mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state.

Returns:

mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state.

setOrderStateSaveModes

public void setOrderStateSaveModes(java.util.Map pOrderStateSaveModes)

Mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state. The possible "saveModes" for saving the PriceInfo objects: ALL - Saves all PriceInfo objects associated with the order. ALL_NO_AUDIT - Saves all PriceInfo objects associated with the order, but does not save the audit trail information associated with those PriceInfos. Audit trail information includes PricingAdjustments and DetailedItemPriceInfos ORDER - Saves only the OrderPriceInfo object (no ItemPriceInfos, ShippingPriceInfos, or TaxPriceInfos) ORDER_NO_AUDIT - Saves only the OrderPriceInfo object, and does not save the audit trail information associated with that object NONE - Saves no PriceInfo objects

Parameters:

pOrderStateSaveModes - mapping of order states to the "saveMode" that indicates the level of pricing information that should be saved for an order in that state.

getDefaultSaveMode

public java.lang.String getDefaultSaveMode()

The saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes

Returns:

the saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes

setDefaultSaveMode

public void setDefaultSaveMode(java.lang.String pDefaultSaveMode)

The saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes

Parameters:

pDefaultSaveMode - he saveMode to be used for orders that do not have a corresponding entry in orderStateSaveModes

getPricingAdjustmentProperties

public java.lang.String[] getPricingAdjustmentProperties()

Returns the pricingAdjustmentProperties

setPricingAdjustmentProperties

public void setPricingAdjustmentProperties(java.lang.String[] pPricingAdjustmentProperties)

Sets the pricingAdjustmentProperties

getDetailedItemPriceInfoProperties

public java.lang.String[] getDetailedItemPriceInfoProperties()

Returns the detailedItemPriceInfoProperties

setDetailedItemPriceInfoProperties

public void setDetailedItemPriceInfoProperties(java.lang.String[] pDetailedItemPriceInfoProperties)

Sets the detailedItemPriceInfoProperties

getAdjustmentsProperty

public java.lang.String getAdjustmentsProperty()

Returns the adjustmentsProperty

setAdjustmentsProperty

public void setAdjustmentsProperty(java.lang.String pAdjustmentsProperty)

Sets the adjustmentsProperty

getCurrentPriceDetailsProperty

public java.lang.String getCurrentPriceDetailsProperty()

Returns the currentPriceDetailsProperty

setCurrentPriceDetailsProperty

public void setCurrentPriceDetailsProperty(java.lang.String pCurrentPriceDetailsProperty)

Sets the currentPriceDetailsProperty

getOrderPriceInfoProperty

public java.lang.String getOrderPriceInfoProperty()

Returns the orderPriceInfoProperty

setOrderPriceInfoProperty

public void setOrderPriceInfoProperty(java.lang.String pOrderPriceInfoProperty)

Sets the orderPriceInfoProperty

getTaxPriceInfoProperty

public java.lang.String getTaxPriceInfoProperty()

Returns the taxPriceInfoProperty

setTaxPriceInfoProperty

public void setTaxPriceInfoProperty(java.lang.String pTaxPriceInfoProperty)

Sets the taxPriceInfoProperty

getShippingPriceInfoProperty

public java.lang.String getShippingPriceInfoProperty()

Returns the shippingPriceInfoProperty

setShippingPriceInfoProperty

public void setShippingPriceInfoProperty(java.lang.String pShippingPriceInfoProperty)

Sets the shippingPriceInfoProperty

getItemPriceInfoProperty

public java.lang.String getItemPriceInfoProperty()

Returns the itemPriceInfoProperty

setItemPriceInfoProperty

public void setItemPriceInfoProperty(java.lang.String pItemPriceInfoProperty)

Sets the itemPriceInfoProperty

getShippingItemsSubtotalPriceInfosProperty

public java.lang.String getShippingItemsSubtotalPriceInfosProperty()

Returns property ShippingItemsSubtotalPriceInfosProperty

Returns:

returns property ShippingItemsSubtotalPriceInfosProperty

setShippingItemsSubtotalPriceInfosProperty

public void setShippingItemsSubtotalPriceInfosProperty(java.lang.String pShippingItemsSubtotalPriceInfosProperty)

Sets property ShippingItemsSubtotalPriceInfosProperty

Parameters:

pShippingItemsSubtotalPriceInfosProperty - the value to set for property ShippingItemsSubtotalPriceInfosProperty

getTaxableShippingItemsSubtotalPriceInfosProperty

public java.lang.String getTaxableShippingItemsSubtotalPriceInfosProperty()

Returns property TaxableShippingItemsSubtotalPriceInfosProperty

Returns:

returns property TaxableShippingItemsSubtotalPriceInfosProperty

setTaxableShippingItemsSubtotalPriceInfosProperty

public void setTaxableShippingItemsSubtotalPriceInfosProperty(java.lang.String pTaxableShippingItemsSubtotalPriceInfosProperty)

Sets property TaxableShippingItemsSubtotalPriceInfosProperty

Parameters:

pTaxableShippingItemsSubtotalPriceInfosProperty - the value to set for property TaxableShippingItemsSubtotalPriceInfosProperty

getNonTaxableShippingItemsSubtotalPriceInfosProperty

public java.lang.String getNonTaxableShippingItemsSubtotalPriceInfosProperty()

Returns property nonTaxableShippingItemsSubtotalPriceInfosProperty

Returns:

returns property nonTaxableShippingItemsSubtotalPriceInfosProperty

setNonTaxableShippingItemsSubtotalPriceInfosProperty

public void setNonTaxableShippingItemsSubtotalPriceInfosProperty(java.lang.String pNonTaxableShippingItemsSubtotalPriceInfosProperty)

Sets property NonTaxableShippingItemsSubtotalPriceInfosProperty

Parameters:

pNonTaxableShippingItemsSubtotalPriceInfosProperty - the value to set for property NonTaxableShippingItemsSubtotalPriceInfosProperty

getShippingItemsTaxPriceInfosProperty

public java.lang.String getShippingItemsTaxPriceInfosProperty()

Returns property ShippingItemsTaxPriceInfosProperty

Returns:

returns property ShippingItemsTaxPriceInfosProperty

setShippingItemsTaxPriceInfosProperty

public void setShippingItemsTaxPriceInfosProperty(java.lang.String pShippingItemsTaxPriceInfosProperty)

Sets property ShippingItemsTaxPriceInfosProperty

Parameters:

pShippingItemsTaxPriceInfosProperty - the value to set for property ShippingItemsTaxPriceInfosProperty

getOrderPriceInfoDescName

public java.lang.String getOrderPriceInfoDescName()

Returns property orderPriceInfoDescName

Returns:

returns property orderPriceInfoDescName

setOrderPriceInfoDescName

public void setOrderPriceInfoDescName(java.lang.String pOrderPriceInfoDescName)

Sets property orderPriceInfoDescName

Parameters:

pOrderPriceInfoDescName - the value to set for property orderPriceInfoDescName

getTaxPriceInfoDescName

public java.lang.String getTaxPriceInfoDescName()

Returns property taxPriceInfoDescName

Returns:

returns property taxPriceInfoDescName

setTaxPriceInfoDescName

public void setTaxPriceInfoDescName(java.lang.String pTaxPriceInfoDescName)

Sets property taxPriceInfoDescName

Parameters:

pTaxPriceInfoDescName - the value to set for property taxPriceInfoDescName

getDetailedItemPriceInfoDescName

public java.lang.String getDetailedItemPriceInfoDescName()

Returns the detailedItemPriceInfoDescName

setDetailedItemPriceInfoDescName

public void setDetailedItemPriceInfoDescName(java.lang.String pDetailedItemPriceInfoDescName)

Sets the detailedItemPriceInfoDescName

getPricingAdjustmentDescName

public java.lang.String getPricingAdjustmentDescName()

Returns the pricingAdjustmentDescName

setPricingAdjustmentDescName

public void setPricingAdjustmentDescName(java.lang.String pPricingAdjustmentDescName)

Sets the pricingAdjustmentDescName

setDetailsRangeProperties

public void setDetailsRangeProperties(java.lang.String[] pDetailsRangeProperties)

getDetailsRangeProperties

public java.lang.String[] getDetailsRangeProperties()

The list of properties from the DetailedItemPriceInfo's Range property that are stored in the details repository item

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Sets property LoggingIdentifier

Overrides:

setLoggingIdentifier in class ApplicationLoggingImpl

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Returns property LoggingIdentifier

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl

isSaveOrderPriceInfo

public boolean isSaveOrderPriceInfo(java.lang.String pOrderState)

Returns true if the order price info will be saved for the given order state.

Parameters:

pOrderState - The order state

Returns:

false if the save mode is NONE else true

runProcess

public int runProcess(java.lang.Object pParam,
             PipelineResult pResult)
               throws java.lang.Exception

This method saves the PriceInfo objects into the OrderRepository from the Order, CommerceItem, and ShippingGroup objects. It iterates through the properties listed in the saveProperties property inherited by this class, setting the values in the repository. This method requires that an Order, OrderRepository, and OrderManager object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - a HashMap which must contain an Order, OrderRepository, and OrderManager object

pResult - a PipelineResult object which stores any information which must be returned from this method invokation

Returns:

an integer specifying the processor's return code

Throws:

java.lang.Exception - throws any exception back to the caller

See Also:

PipelineProcessor.runProcess(Object, PipelineResult), AmountInfo, OrderPriceInfo, ItemPriceInfo, ShippingPriceInfo, TaxPriceInfo

saveOrderPriceInfo

protected void saveOrderPriceInfo(Order order,
                      MutableRepositoryItem orderRepItem,
                      MutableRepository mutRep,
                      OrderManager orderManager)
                           throws RepositoryException,
                                  java.beans.IntrospectionException,
                                  PropertyNotFoundException,
                                  CommerceException

This method saves the OrderPriceInfo object in the Order class.

Parameters:

order - The order being saved

orderRepItem - The repository item corresponding to the order

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

savePriceInfo(atg.commerce.order.Order, atg.commerce.order.CommerceIdentifier, atg.repository.MutableRepositoryItem, java.lang.String, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveTaxPriceInfo

protected void saveTaxPriceInfo(Order order,
                    MutableRepositoryItem orderRepItem,
                    MutableRepository mutRep,
                    OrderManager orderManager)
                         throws RepositoryException,
                                java.beans.IntrospectionException,
                                PropertyNotFoundException,
                                CommerceException

This method saves the TaxPriceInfo object in the Order class.

Parameters:

order - The order being saved

orderRepItem - The repository item corresponding to the order

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

savePriceInfo(atg.commerce.order.Order, atg.commerce.order.CommerceIdentifier, atg.repository.MutableRepositoryItem, java.lang.String, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveItemPriceInfo

protected void saveItemPriceInfo(Order order,
                     CommerceItem cItem,
                     MutableRepositoryItem cItemRepItem,
                     MutableRepository mutRep,
                     OrderManager orderManager)
                          throws RepositoryException,
                                 java.beans.IntrospectionException,
                                 PropertyNotFoundException,
                                 CommerceException

This method saves an ItemPriceInfo object. If the input commerceItem is a configurable sku, then the method loads the ItemPriceInfo of all the subskus of the configurable sku.

Parameters:

order - The order being saved

cItem - The commerce item object

cItemRepItem - The repository item corresponding to the commerce item

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

savePriceInfo(atg.commerce.order.Order, atg.commerce.order.CommerceIdentifier, atg.repository.MutableRepositoryItem, java.lang.String, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveSubSkuPriceInfo

protected void saveSubSkuPriceInfo(Order order,
                       CommerceItem cItem,
                       MutableRepositoryItem configRepItem,
                       MutableRepository mutRep,
                       OrderManager orderManager)
                            throws RepositoryException,
                                   java.beans.IntrospectionException,
                                   PropertyNotFoundException,
                                   CommerceException

This method saves ItemPriceInfo objects for skus of a configurable sku.

Parameters:

order - The order being saved

cItem - The configurable commerce item whose price is being saved

configRepItem - The repository item corresponding to the commerce item

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

savePriceInfo(atg.commerce.order.Order, atg.commerce.order.CommerceIdentifier, atg.repository.MutableRepositoryItem, java.lang.String, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveShippingPriceInfo

protected void saveShippingPriceInfo(Order order,
                         ShippingGroup group,
                         MutableRepositoryItem groupRepItem,
                         MutableRepository mutRep,
                         OrderManager orderManager)
                              throws RepositoryException,
                                     java.beans.IntrospectionException,
                                     PropertyNotFoundException,
                                     CommerceException

This method saves a ShippingPriceInfo object.

Parameters:

order - The order being saved

group - The shipping group whose price is being saved

groupRepItem - The repository item corresponding to the shipping group

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

savePriceInfo(atg.commerce.order.Order, atg.commerce.order.CommerceIdentifier, atg.repository.MutableRepositoryItem, java.lang.String, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

savePriceInfo

protected MutableRepositoryItem savePriceInfo(Order order,
                                  CommerceIdentifier ci,
                                  MutableRepositoryItem piRepItem,
                                  java.lang.String repItemPropName,
                                  AmountInfo pPriceInfo,
                                  MutableRepository mutRep,
                                  OrderManager orderManager)
                                       throws RepositoryException,
                                              java.beans.IntrospectionException,
                                              PropertyNotFoundException,
                                              CommerceException

This method saves an individual PriceInfo object. It is called by all the other save methods. It will call the following methods as relevant:

Parameters:

order - The order being saved

ci - The commerce object whose price info is being saved

piRepItem - The repository item corresponding to the commerce object

repItemPropName - The property of piRepItem that stores the price info

pPriceInfo - The price info object that will be saved to piRepItem.repItemPropName

mutRep - The repository where the order is being saved

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), savePricingAdjustments(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveDetailedItemPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveShippingItemsSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveTaxableShippingItemsSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveNonTaxableShippingItemsSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveShippingItemsTaxPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveShippingItemsSubtotalPriceInfos

protected void saveShippingItemsSubtotalPriceInfos(Order order,
                                       AmountInfo pPriceInfo,
                                       MutableRepositoryItem mutItem,
                                       MutableRepository mutRep,
                                       OrderManager orderManager)
                                            throws RepositoryException,
                                                   java.beans.IntrospectionException,
                                                   PropertyNotFoundException,
                                                   CommerceException

This method is a pass through to the saveSubtotalPriceInfos method. It passes in the shippingItemsSubtotalPriceInfosProperty value as the property name

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

saveSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager, java.lang.String)

saveTaxableShippingItemsSubtotalPriceInfos

protected void saveTaxableShippingItemsSubtotalPriceInfos(Order order,
                                              AmountInfo pPriceInfo,
                                              MutableRepositoryItem mutItem,
                                              MutableRepository mutRep,
                                              OrderManager orderManager)
                                                   throws RepositoryException,
                                                          java.beans.IntrospectionException,
                                                          PropertyNotFoundException,
                                                          CommerceException

This method is a pass through to the saveSubtotalPriceInfos method. It passes in the taxableShippingItemsSubtotalPriceInfosProperty value as the property name

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

saveSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager, java.lang.String)

saveNonTaxableShippingItemsSubtotalPriceInfos

protected void saveNonTaxableShippingItemsSubtotalPriceInfos(Order order,
                                                 AmountInfo pPriceInfo,
                                                 MutableRepositoryItem mutItem,
                                                 MutableRepository mutRep,
                                                 OrderManager orderManager)
                                                      throws RepositoryException,
                                                             java.beans.IntrospectionException,
                                                             PropertyNotFoundException,
                                                             CommerceException

This method is a pass through to the saveSubtotalPriceInfos method. It passes in the nonTaxableShippingItemsSubtotalPriceInfosProperty value as the property name

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

saveSubtotalPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager, java.lang.String)

saveSubtotalPriceInfos

protected void saveSubtotalPriceInfos(Order order,
                          AmountInfo pPriceInfo,
                          MutableRepositoryItem mutItem,
                          MutableRepository mutRep,
                          OrderManager orderManager,
                          java.lang.String pPropertyName)
                               throws RepositoryException,
                                      java.beans.IntrospectionException,
                                      PropertyNotFoundException,
                                      CommerceException

This method saves a Map of (shipping group -> price info) objects into the repository See the savedProperties for a list of properties that are copied

Parameters:

order - The order being loaded

pPriceInfo - The amount info being saved

mutItem - The repository item for the pPriceInfo

mutRep - The repository being updated

orderManager - The OrderManager in the pipeline params

pPropertyName - The name of the map to load

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), savePricingAdjustments(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveDetailedItemPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveShippingItemsTaxPriceInfos

protected void saveShippingItemsTaxPriceInfos(Order order,
                                  AmountInfo pPriceInfo,
                                  MutableRepositoryItem mutItem,
                                  MutableRepository mutRep,
                                  OrderManager orderManager)
                                       throws RepositoryException,
                                              java.beans.IntrospectionException,
                                              PropertyNotFoundException,
                                              CommerceException

This method saves a Map of ShippingItemsTaxPriceInfos objects into the repository See the savedProperties for a list of properties that are copied

Parameters:

order - The order being loaded

pPriceInfo - The amount info being saved

mutItem - The repository item for the pPriceInfo

mutRep - The repository being updated

orderManager - The OrderManager in the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), savePricingAdjustments(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveDetailedItemPriceInfos(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

savePricingAdjustments

protected void savePricingAdjustments(Order order,
                          AmountInfo pPriceInfo,
                          MutableRepositoryItem mutItem,
                          MutableRepository mutRep,
                          OrderManager orderManager)
                               throws RepositoryException,
                                      java.beans.IntrospectionException,
                                      PropertyNotFoundException,
                                      CommerceException

This method saves a List of PricingAdjustment objects in an AmountInfo. See the savedProperties for a list of properties that are copied

Parameters:

order - The order being saved

pPriceInfo - The price info being saved

mutItem - The repository item corresponding to the price info

mutRep - The repository being updated

orderManager - The OrderManager from the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

saveDetailedItemPriceInfos

protected void saveDetailedItemPriceInfos(Order order,
                              AmountInfo pPriceInfo,
                              MutableRepositoryItem mutItem,
                              MutableRepository mutRep,
                              OrderManager orderManager)
                                   throws RepositoryException,
                                          java.beans.IntrospectionException,
                                          PropertyNotFoundException,
                                          CommerceException

This method saves a List of DetailedItemPriceInfo objects in an ItemPriceInfo. See the detailedItemPriceInfoProperties for a list of properties that are copied

Parameters:

order - The order being loaded

pPriceInfo - The amount info for the commerce item

mutItem - The repository item for the price info

mutRep - The repository for the price info

orderManager - The OrderManager in the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), savePricingAdjustments(atg.commerce.order.Order, atg.commerce.pricing.AmountInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager), saveDetailedRange(atg.commerce.order.Order, atg.commerce.pricing.DetailedItemPriceInfo, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

addProperties

protected void addProperties(Order order,
                 java.lang.String[] propertyList,
                 java.lang.Object obj,
                 MutableRepositoryItem mutItem,
                 MutableRepository mutRep,
                 OrderManager orderManager)
                      throws RepositoryException,
                             java.beans.IntrospectionException,
                             CommerceException

Throws:

RepositoryException

java.beans.IntrospectionException

CommerceException

writeItemToRepository

protected void writeItemToRepository(Order order,
                         MutableRepository mutRep,
                         MutableRepositoryItem mutItem)
                              throws RepositoryException,
                                     java.beans.IntrospectionException,
                                     CommerceException

Update a given repository with the item passed in.

Parameters:

order - - The order associated with the item we are writing to the repository.

mutRep - - the repository we are writing to

mutItem - - the item we are writing

Throws:

RepositoryException

java.beans.IntrospectionException

CommerceException

writeProperties

protected void writeProperties(Order order,
                   java.lang.String[] propertyList,
                   java.lang.Object obj,
                   MutableRepositoryItem mutItem,
                   MutableRepository mutRep,
                   OrderManager orderManager)
                        throws RepositoryException,
                               java.beans.IntrospectionException,
                               CommerceException

This method saves a List of properties to a repository item.

Parameters:

order - The order being loaded

propertyList - The list of properties to write

obj - The object that each property is copied from

mutItem - The repository item that each property is copied into

mutRep - The repository that is updated

orderManager - The OrderManager in the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

CommerceException

writeProperties

protected void writeProperties(Order pOrder,
                   java.util.Map<java.lang.String[],java.lang.Object> pPropertyListToSourceObject,
                   MutableRepositoryItem pItemToCopyTo,
                   MutableRepository pMutRep,
                   OrderManager pOrderManager)
                        throws RepositoryException,
                               java.beans.IntrospectionException,
                               CommerceException

This method saves a List of properties to a repository item, allowing for more than one source object.

Parameters:

pOrder - The order being loaded

pPropertyListToSourceObject - A map of property lists to copy and their associated source objects

pMutItem - The repository item that each property is copied into

pMutRep - The repository that is being updated

pOrderManager - The OrderManager in the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

CommerceException

saveDetailedRange

protected void saveDetailedRange(Order pOrder,
                     DetailedItemPriceInfo pDetail,
                     MutableRepositoryItem pDetMutItem,
                     MutableRepository pMutRep,
                     OrderManager pOrderManager)
                          throws RepositoryException,
                                 java.beans.IntrospectionException,
                                 PropertyNotFoundException,
                                 CommerceException

Save the range property in a detailed item price info See the detailsRangeProperties for a list of properties that are copied

Parameters:

pOrder - The order being loaded

pDetail - The detailed item price being loaded

pDetMutItem - The repository item corresponding to the detail

pMutRep - The repository that is updated

pOrderManager - The order manager in the pipeline params

Throws:

RepositoryException

java.beans.IntrospectionException

PropertyNotFoundException

CommerceException

See Also:

writeProperties(atg.commerce.order.Order, java.lang.String[], java.lang.Object, atg.repository.MutableRepositoryItem, atg.repository.MutableRepository, atg.commerce.order.OrderManager)

verifySaveModes

protected void verifySaveModes()
                        throws CommerceException

Verify that each of the saveModes in orderStateSaveModes, and defaultSaveMode, are valid saveModes

Throws:

CommerceException