atg.commerce.order.processor
Class ProcExecuteChain

java.lang.Object
  atg.nucleus.logging.ApplicationLoggingImpl
      atg.commerce.order.processor.ProcExecuteChain

All Implemented Interfaces:

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

public class ProcExecuteChain
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor executes a chain from within a processor of another chain. The pipelineManager property is the PipelineManager that the chain, specified by the chainToRun property, exists in.

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

ProcExecuteChain()

Method Summary

java.lang.String	getChainToRun() Returns the chainToRun
int	getFailureReturnValue() Returns property failureReturnValue
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
PipelineManager	getPipelineManager() Returns the PipelineManager
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	getSuccessReturnValue() Returns property successReturnValue
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method executes a chain from within a processor of another chain.
void	setChainToRun(java.lang.String pChainToRun) Sets the chainToRun
void	setFailureReturnValue(int pFailureReturnValue) Sets property failureReturnValue
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setPipelineManager(PipelineManager pPipelineManager) Sets the PipelineManager
void	setSuccessReturnValue(int pSuccessReturnValue) Sets property successReturnValue

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

ProcExecuteChain

public ProcExecuteChain()

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.

getSuccessReturnValue

public int getSuccessReturnValue()

Returns property successReturnValue

Returns:

returns property successReturnValue

setSuccessReturnValue

public void setSuccessReturnValue(int pSuccessReturnValue)

Sets property successReturnValue

Parameters:

pSuccessReturnValue - the value to set for property successReturnValue

getFailureReturnValue

public int getFailureReturnValue()

Returns property failureReturnValue

Returns:

returns property failureReturnValue

setFailureReturnValue

public void setFailureReturnValue(int pFailureReturnValue)

Sets property failureReturnValue

Parameters:

pFailureReturnValue - the value to set for property failureReturnValue

getPipelineManager

public PipelineManager getPipelineManager()

Returns the PipelineManager

setPipelineManager

public void setPipelineManager(PipelineManager pPipelineManager)

Sets the PipelineManager

getChainToRun

public java.lang.String getChainToRun()

Returns the chainToRun

setChainToRun

public void setChainToRun(java.lang.String pChainToRun)

Sets the chainToRun

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 executes a chain from within a processor of another chain. The pipelineManager property is the PipelineManager that the chain, specified by the chainToRun property, exists in. This method requires that an Order and optionally a Locale 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 and optionally a Locale 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)