atg.commerce.pricing.processor

Class PriceOrderTotal

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.pricing.processor.PriceOrderTotal

All Implemented Interfaces:

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

public class PriceOrderTotal
extends ApplicationLoggingImpl
implements PipelineProcessor

A pipeline processor which is used to reprice an order. The order is repriced depending on the pricing operation command which is supplied. The operations which are supported are defined in the atg.commerce.pricing.PricingConstants interface. They include:

• PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
• PricingConstants.OP_REPRICE_ITEMS -> ITEMS
• PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
• PricingConstants.OP_REPRICE_ORDER -> ORDER
• PricingConstants.OP_REPRICE_TAX -> TAX

See Also:

PricingConstants

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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
PriceOrderTotal() Constructs an instanceof PriceOrderTotal

Method Summary

Modifier and Type	Method and Description
PricingTools	getPricingTools() Returns property PricingTools
int[]	getRetCodes() Returns the valid return codes 1 - Order priced successfully 2 - Order pricing failed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Reprice the order by extracting out the necessary parameters from the Map which should be supplied as the param pParam.
void	setPricingTools(PricingTools pPricingTools) Sets property PricingTools

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

Constructor Detail

PriceOrderTotal

public PriceOrderTotal()

Constructs an instanceof PriceOrderTotal

Method Detail

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

Sets property PricingTools

getPricingTools

public PricingTools getPricingTools()

Returns property PricingTools

runProcess

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

Reprice the order by extracting out the necessary parameters from the Map which should be supplied as the param pParam. The following parameters should be in the map.

• PricingConstants.PRICING_OPERATION_PARAM
• PricingConstants.ORDER_PARAM
• PricingConstants.PRICING_MODELS_PARAM (optional: if executed in the context of a request)
• PricingConstants.LOCALE_PARAM (optional)
• PricingConstants.PROFILE_PARAM
• PricingConstants.EXTRA_PARAMETERS_PARAM (optional)

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - The object should be an instance of Map

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. SUCCESS: (1) OR STOP_CHAIN_EXECUTION_AND_ROLLBACK:

Throws:

java.lang.Exception

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - Order priced successfully 2 - Order pricing failed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

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