atg.commerce.order.processor

Class ProcPrepareForQuoteCheckout

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.ProcPrepareForQuoteCheckout

All Implemented Interfaces:

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

public class ProcPrepareForQuoteCheckout
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor is responsible for preparing the pipeline for the checkout of a quote.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected int[]	mRetCodes

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

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
boolean	isCheckForExpiredPromotions() Returns property checkForExpiredPromotions
protected void	prepareForQuoteCheckout(java.util.Map pMap) The method is used to prepare for the checkout of a quote.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method is used to prepare the pipeline for the checkout of a quote.
void	setCheckForExpiredPromotions(boolean pCheckForExpiredPromotions) Sets property checkForExpiredPromotions

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

Class version string

mRetCodes

protected int[] mRetCodes

Constructor Detail

ProcPrepareForQuoteCheckout

public ProcPrepareForQuoteCheckout()

Method Detail

isCheckForExpiredPromotions

public boolean isCheckForExpiredPromotions()

Returns property checkForExpiredPromotions

Returns:

a boolean value

setCheckForExpiredPromotions

public void setCheckForExpiredPromotions(boolean pCheckForExpiredPromotions)

Sets property checkForExpiredPromotions

Parameters:

pCheckForExpiredPromotions - a boolean value

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.

runProcess

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

This method is used to prepare the pipeline for the checkout of a quote.

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 invocation

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)

prepareForQuoteCheckout

protected void prepareForQuoteCheckout(java.util.Map pMap)

The method is used to prepare for the checkout of a quote.

The default logic turns off the check for expired promotions by adding the PipelineConstants.BYPASSEXPIREDPROMOTIONSCHECK flag to the pipeline map. Use the checkForExpiredPromotions property to toggle this behavior.

Parameters:

pMap - the pipeline processor map

See Also:

OrderTools.addBypassExpiredPromotionsCheckParameter(Map)