atg.b2bcommerce.order.processor
Class ProcLoadCostCenterObjects

java.lang.Object
  atg.nucleus.logging.ApplicationLoggingImpl
      atg.commerce.order.processor.LoadProperties
          atg.b2bcommerce.order.processor.ProcLoadCostCenterObjects

All Implemented Interfaces:

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

public class ProcLoadCostCenterObjects
extends LoadProperties
implements PipelineProcessor

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

See Also:

atg.commerce.order.CostCenter

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

ProcLoadCostCenterObjects()

Method Summary

java.lang.String	getCostCentersProperty() Returns the CostCentersProperty 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
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method loads the CostCenter objects from the OrderRepository into the Order object.
void	setCostCentersProperty(java.lang.String pCostCentersProperty) Sets the CostCentersProperty 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, 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 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

ProcLoadCostCenterObjects

public ProcLoadCostCenterObjects()

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.

getCostCentersProperty

public java.lang.String getCostCentersProperty()

Returns the CostCentersProperty name. This is the CostCenters property in the Order repository item.

setCostCentersProperty

public void setCostCentersProperty(java.lang.String pCostCentersProperty)

Sets the CostCentersProperty name. This is the CostCenters 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 CostCenter objects from the OrderRepository into the Order object. It does this by constructing a new CostCenter instance based on the class mapped to the repository item type of the CostCenter. 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 B2BPipelineConstants 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), atg.commerce.order.CostCenter

invalidateCache

protected void invalidateCache(ItemDescriptorImpl desc,
                               MutableRepositoryItem mutItem)

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