atg.commerce.order.processor
Class ProcLoadCommerceItemObjects

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.LoadProperties
              atg.commerce.order.processor.ProcLoadCommerceItemObjects

All Implemented Interfaces:

ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcLoadCommerceItemObjects
extends LoadProperties
implements PipelineProcessor

This processor loads the CommerceItem objects from the OrderRepository into the Order object.

See Also:

CommerceItem

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ProcLoadCommerceItemObjects()

Method Summary

java.lang.String	getCommerceItemsProperty() Returns the commerceItemsProperty name.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected void	invalidateCache(ItemDescriptorImpl desc, MutableRepositoryItem mutItem) This method invalidates the item from the cache if invalidateCache is true
protected void	loadCommerceItems(Order order, CommerceItemContainer itemContainer, java.util.List commerceItems, OrderManager orderManager, OrderTools orderTools) Deprecated. use loadCommerceItems(Order, CommerceItemContainer, List, OrderManager, OrderTools, Boolean)
protected void	loadCommerceItems(Order order, CommerceItemContainer itemContainer, java.util.List commerceItems, OrderManager orderManager, OrderTools orderTools, java.lang.Boolean invalidateCache) This method is the one that actually goes through the work of building commerce item objects out of the data in the order repository.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method loads the CommerceItem objects from the OrderRepository into the Order object.
void	setCommerceItemsProperty(java.lang.String pCommerceItemsProperty) Sets the commerceItemsProperty name.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier

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

getLoadProperties, getMappedPropertyName, getPropertyDescriptorToBeanPropertyMap, setLoadProperties, setPropertyDescriptorToBeanPropertyMap

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, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcLoadCommerceItemObjects

public ProcLoadCommerceItemObjects()

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.

getCommerceItemsProperty

public java.lang.String getCommerceItemsProperty()

Returns the commerceItemsProperty name. This is the commerceItems property in the Order repository item.

setCommerceItemsProperty

public void setCommerceItemsProperty(java.lang.String pCommerceItemsProperty)

Sets the commerceItemsProperty name. This is the commerceItems property in the Order 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

runProcess

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

This method loads the CommerceItem objects from the OrderRepository into the Order object. It does this by constructing a new CommerceItem instance based on the class mapped to the repository item type of the CommerceItem. It then iterates through the properties listed in the loadProperties property inherited by this class, setting the values in the object. This method requires that an Order, order repository item, 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, order repository item, 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)

loadCommerceItems

protected void loadCommerceItems(Order order,
                                 CommerceItemContainer itemContainer,
                                 java.util.List commerceItems,
                                 OrderManager orderManager,
                                 OrderTools orderTools)
                          throws java.lang.Exception

Deprecated. use loadCommerceItems(Order, CommerceItemContainer, List, OrderManager, OrderTools, Boolean)

Throws:

java.lang.Exception

loadCommerceItems

protected void loadCommerceItems(Order order,
                                 CommerceItemContainer itemContainer,
                                 java.util.List commerceItems,
                                 OrderManager orderManager,
                                 OrderTools orderTools,
                                 java.lang.Boolean invalidateCache)
                          throws java.lang.Exception

This method is the one that actually goes through the work of building commerce item objects out of the data in the order repository. It first creates a new instance of the commerce item class (using the type configured in OrderTools.beanNameToItemDescriptorMap Once the object is created, the id is set, then each property in loadProperties is copied into the object (this list is usually empty, since most properties directly read from the repository item). The item is then added to the given order. If The item is a CommerceItemContainer (e.g. ConfigurableCommerceItem) then this method is recursively called.

Parameters:

order - The order being created

itemContainer - The container for the commerce items being created. This is usually the same object as "order"

commerceItems - The list of commerceItem repository items

orderManager - The OrderManager passed in with the pipeline params

orderTools - The OrderTools passed in with the pipeline params

invalidateCache - If true, then each commerce item's repository cache entry is invalidated

Throws:

java.lang.Exception

invalidateCache

protected void invalidateCache(ItemDescriptorImpl desc,
                               MutableRepositoryItem mutItem)

This method invalidates the item from the cache if invalidateCache is true