atg.commerce.approval.processor

Class ProcVerifyApproval

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.approval.processor.ProcVerifyApproval

All Implemented Interfaces:

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

public class ProcVerifyApproval
extends ApplicationLoggingImpl
implements PipelineProcessor

This class returns the value in the alreadyApprovedReturnValue property if the state or the order is the same as the state in thge approvedOrderState property of this class. If not, then the value in notYetApprovedReturnValue is returned.

Field Summary

Fields

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

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
ProcVerifyApproval()

Method Summary

Modifier and Type	Method and Description
int	getAlreadyApprovedReturnValue() Returns property alreadyApprovedReturnValue
java.lang.String	getApprovedOrderState() Returns property approvedOrderState
int	getNotYetApprovedReturnValue() Returns property notYetApprovedReturnValue
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method returns the value in the alreadyApprovedReturnValue property if the state or the order is the same as the state in thge approvedOrderState property of this class.
void	setAlreadyApprovedReturnValue(int pAlreadyApprovedReturnValue) Sets property alreadyApprovedReturnValue
void	setApprovedOrderState(java.lang.String pApprovedOrderState) Sets property approvedOrderState
void	setNotYetApprovedReturnValue(int pNotYetApprovedReturnValue) Sets property notYetApprovedReturnValue

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

NOT_YET_APPROVED

public final int NOT_YET_APPROVED

See Also:

Constant Field Values

Constructor Detail

ProcVerifyApproval

public ProcVerifyApproval()

Method Detail

getNotYetApprovedReturnValue

public int getNotYetApprovedReturnValue()

Returns property notYetApprovedReturnValue

Returns:

returns property notYetApprovedReturnValue

setNotYetApprovedReturnValue

public void setNotYetApprovedReturnValue(int pNotYetApprovedReturnValue)

Sets property notYetApprovedReturnValue

Parameters:

pNotYetApprovedReturnValue - the value to set for property notYetApprovedReturnValue

getAlreadyApprovedReturnValue

public int getAlreadyApprovedReturnValue()

Returns property alreadyApprovedReturnValue

Returns:

returns property alreadyApprovedReturnValue

setAlreadyApprovedReturnValue

public void setAlreadyApprovedReturnValue(int pAlreadyApprovedReturnValue)

Sets property alreadyApprovedReturnValue

Parameters:

pAlreadyApprovedReturnValue - the value to set for property alreadyApprovedReturnValue

getApprovedOrderState

public java.lang.String getApprovedOrderState()

Returns property approvedOrderState

Returns:

returns property approvedOrderState

setApprovedOrderState

public void setApprovedOrderState(java.lang.String pApprovedOrderState)

Sets property approvedOrderState

Parameters:

pApprovedOrderState - the value to set for property approvedOrderState

runProcess

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

This method returns the value in the alreadyApprovedReturnValue property if the state or the order is the same as the state in thge approvedOrderState property of this class. If not, then the value in notYetApprovedReturnValue is returned.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

pResult - the PipelineResult object which is used to return errors or other data

Returns:

an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception

getRetCodes

public int[] getRetCodes()

Description copied from interface: PipelineProcessor

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.