atg.commerce.approval.processor
Class ProcAddApproverIdToOrder

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.approval.processor.ProcAddApproverIdToOrder

All Implemented Interfaces:

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

Direct Known Subclasses:

ProcAddApproverIdToOrder

public class ProcAddApproverIdToOrder
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor adds an approver's profile id to the order being approved.

Field Summary

static java.lang.String	CLASS_VERSION
int	SUCCESS code for successful process

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

ProcAddApproverIdToOrder()
Creates a new ProcAddApproverIdToOrder instance.

Method Summary

java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
int[]	getRetCodes() Specifies the return codes from this processor.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method actually runs the process.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier

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

SUCCESS

public final int SUCCESS

code for successful process

See Also:

Constant Field Values

Constructor Detail

ProcAddApproverIdToOrder

public ProcAddApproverIdToOrder()

Creates a new ProcAddApproverIdToOrder instance.

Method Detail

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 actually runs the process. This method adds the profile id to the order's approver ids list. It requires that the Order and Profile be supplied in pParam.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - parameter of user params

pResult - the pipeline result object where results are placed

Returns:

an integer specifying the processors return code

Throws:

java.lang.Exception - throws an exception back to the caller

getRetCodes

public int[] getRetCodes()

Specifies the return codes from this processor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an integer array of valid codes