atg.commerce.order.processor
Class ProcSaveCommerceItemObjects

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.SavedProperties
              atg.commerce.order.processor.ProcSaveCommerceItemObjects

All Implemented Interfaces:

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

public class ProcSaveCommerceItemObjects
extends SavedProperties
implements PipelineProcessor

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

See Also:

CommerceItem

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ProcSaveCommerceItemObjects()

Method Summary

java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getOrderPropertyDescName() Returns property orderPropertyDescName
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method saves the CommerceItem objects into the OrderRepository from the Order object.
protected boolean	saveCommerceItems(Order order, java.util.List items, OrderManager orderManager, OrderTools orderTools, MutableRepository mutRep) This method iterates across each of the given commerce items and updates the repository.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setOrderPropertyDescName(java.lang.String pOrderPropertyDescName) Sets property orderPropertyDescName

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

ProcSaveCommerceItemObjects

public ProcSaveCommerceItemObjects()

Method Detail

getOrderPropertyDescName

public java.lang.String getOrderPropertyDescName()

Returns property orderPropertyDescName

Returns:

returns property orderPropertyDescName

setOrderPropertyDescName

public void setOrderPropertyDescName(java.lang.String pOrderPropertyDescName)

Sets property orderPropertyDescName

Parameters:

pOrderPropertyDescName - the value to set for property orderPropertyDescName

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.

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 saves the CommerceItem objects into the OrderRepository from the Order object. 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), CommerceItem

saveCommerceItems

protected boolean saveCommerceItems(Order order,
                                    java.util.List items,
                                    OrderManager orderManager,
                                    OrderTools orderTools,
                                    MutableRepository mutRep)
                             throws java.lang.Exception

This method iterates across each of the given commerce items and updates the repository. If the commerce item has never been added to the repository, it will be in this method. This method will also set the "order" property on the commerceItem repository item.

Parameters:

order - The order being saved

items - The list of CommerceItem objects that will be saved/added to the repository

orderManager - The OrderManager that was in the pipeline params

orderTools - The OrderTools that was in the pipeline params

mutRep - The repository to which the items are saved

Throws:

java.lang.Exception