atg.commerce.order.processor
Class ProcCheckOrderState

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.logging.ApplicationLoggingImpl
          extended by atg.commerce.order.processor.ProcCheckOrderState
All Implemented Interfaces:
ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcCheckOrderState
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor returns the value in successReturnValue if the order state is in the statesList property. Otherwise it returns the value in failureReturnValue.


Field Summary
static java.lang.String CLASS_VERSION
           
 int FAILURE
           
 
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
ProcCheckOrderState()
           
 
Method Summary
 int getFailureReturnValue()
          Returns property failureReturnValue
 int[] getRetCodes()
          Returns an array of all the return codes that could be returned by this PipelineProcessor.
 java.lang.String[] getStatesList()
          Returns property StatesList
 int getSuccessReturnValue()
          Returns property successReturnValue
 int runProcess(java.lang.Object pParam, PipelineResult pResult)
          This method returns the value in successReturnValue if the order state is in the statesList property.
 void setFailureReturnValue(int pFailureReturnValue)
          Sets property failureReturnValue
 void setStatesList(java.lang.String[] pStatesList)
          Sets property StatesList
 void setSuccessReturnValue(int pSuccessReturnValue)
          Sets property successReturnValue
 
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

FAILURE

public final int FAILURE
See Also:
Constant Field Values
Constructor Detail

ProcCheckOrderState

public ProcCheckOrderState()
Method Detail

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

getStatesList

public java.lang.String[] getStatesList()
Returns property StatesList

Returns:
returns property StatesList

setStatesList

public void setStatesList(java.lang.String[] pStatesList)
Sets property StatesList

Parameters:
pStatesList - the value to set for property StatesList

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception
This method returns the value in successReturnValue if the order state is in the statesList property. Otherwise it returns the value in failureReturnValue.

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.