atg.commerce.approval.processor

Class ProcAddApprovalSystemMessagesToOrder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.approval.processor.ProcAddApprovalSystemMessagesToOrder

All Implemented Interfaces:

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

Direct Known Subclasses:

ProcAddApprovalSystemMessagesToOrder

public class ProcAddApprovalSystemMessagesToOrder
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor adds the error messages in the PipelineResult object to the approverMessages property in the Order object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static int	SUCCESS

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
ProcAddApprovalSystemMessagesToOrder() Creates a new ProcAddApprovalSystemMessagesToOrder instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getClearOldMessages() Returns property clearOldMessages
boolean	getRemoveMessagesFromPipelineResult() Returns property removeMessagesFromPipelineResult
int[]	getRetCodes() The return codes that this processor can return.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method puts all the approval error messages into the approvalSystemMessages property of an order.
void	setClearOldMessages(boolean pClearOldMessages) Sets property clearOldMessages
void	setRemoveMessagesFromPipelineResult(boolean pRemoveMessagesFromPipelineResult) Sets property removeMessagesFromPipelineResult

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLoggingIdentifier, 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, setLoggingIdentifier, 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

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

Constructor Detail

ProcAddApprovalSystemMessagesToOrder

public ProcAddApprovalSystemMessagesToOrder()

Creates a new ProcAddApprovalSystemMessagesToOrder instance.

Method Detail

getClearOldMessages

public boolean getClearOldMessages()

Returns property clearOldMessages

Returns:

returns property clearOldMessages

setClearOldMessages

public void setClearOldMessages(boolean pClearOldMessages)

Sets property clearOldMessages

Parameters:

pClearOldMessages - the value to set for property clearOldMessages

getRemoveMessagesFromPipelineResult

public boolean getRemoveMessagesFromPipelineResult()

Returns property removeMessagesFromPipelineResult

Returns:

returns property removeMessagesFromPipelineResult

setRemoveMessagesFromPipelineResult

public void setRemoveMessagesFromPipelineResult(boolean pRemoveMessagesFromPipelineResult)

Sets property removeMessagesFromPipelineResult

Parameters:

pRemoveMessagesFromPipelineResult - the value to set for property removeMessagesFromPipelineResult

runProcess

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

This method puts all the approval error messages into the approvalSystemMessages property of an order.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - list of params to pipeline

pResult - the pipeline result object

Returns:

code indicating state

Throws:

java.lang.Exception - if an error occurs

getRetCodes

public int[] getRetCodes()

The return codes that this processor can return. The list of return codes are:

• 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an int[] of the valid return codes