atg.commerce.order.processor

Class ProcLoadHandlingInstructionObjects

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.LoadProperties

atg.commerce.order.processor.ProcLoadHandlingInstructionObjects

All Implemented Interfaces:

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

public class ProcLoadHandlingInstructionObjects
extends LoadProperties
implements PipelineProcessor

This method loads the HandlingInstruction objects from the OrderRepository into a ShippingGroup in the Order object.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ProcLoadHandlingInstructionObjects()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHandlingInstructionsProperty() Returns the handlingInstructionsProperty name.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
java.lang.String	getShippingGroupsProperty() Returns the shippingGroupsProperty name.
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 HandlingInstruction objects from the OrderRepository into a ShippingGroup in the Order object.
void	setHandlingInstructionsProperty(java.lang.String pHandlingInstructionsProperty) Sets the handlingInstructionsProperty name.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setShippingGroupsProperty(java.lang.String pShippingGroupsProperty) Sets the shippingGroupsProperty name.

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

Constructor Detail

ProcLoadHandlingInstructionObjects

public ProcLoadHandlingInstructionObjects()

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.

getShippingGroupsProperty

public java.lang.String getShippingGroupsProperty()

Returns the shippingGroupsProperty name. This is the shippingGroups property in the Order repository item.

setShippingGroupsProperty

public void setShippingGroupsProperty(java.lang.String pShippingGroupsProperty)

Sets the shippingGroupsProperty name. This is the shippingGroups property in the Order repository item.

getHandlingInstructionsProperty

public java.lang.String getHandlingInstructionsProperty()

Returns the handlingInstructionsProperty name. This is the handlingInstructions property in the ShippingGroup repository item.

setHandlingInstructionsProperty

public void setHandlingInstructionsProperty(java.lang.String pHandlingInstructionsProperty)

Sets the handlingInstructionsProperty name. This is the handlingInstructions property in the ShippingGroup 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 HandlingInstruction objects from the OrderRepository into a ShippingGroup in the Order object. It does this by constructing a new HandlingInstruction instance based on the class mapped to the repository item type of the HandlingInstruction. 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)

invalidateCache

protected void invalidateCache(ItemDescriptorImpl desc,
                   MutableRepositoryItem mutItem)

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