atg.commerce.order.processor
Class ProcValidateCurrencyCodes

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.ProcValidateCurrencyCodes

All Implemented Interfaces:

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

public class ProcValidateCurrencyCodes
extends ApplicationLoggingImpl
implements PipelineProcessor

Validates that all the PriceInfo objects in the Order have been priced using the same currency code. The currency code in the OrderPriceInfo object is the one which must be matched. The code checks the TaxPriceInfo object's currency code in the Order and all the ShippingPriceInfo and ItemPriceInfo currency codes in all the ShippingGroups and CommerceItems, respectively.

Field Summary

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

ProcValidateCurrencyCodes()

Method Summary

java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Validates that all the PriceInfo objects in the Order have been priced using the same currency code.
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, 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

ProcValidateCurrencyCodes

public ProcValidateCurrencyCodes()

Method Detail

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.

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

Validates that all the PriceInfo objects in the Order have been priced using the same currency code. The currency code in the OrderPriceInfo object is the one which must be matched. The code checks the TaxPriceInfo object's currency code in the Order and all the ShippingPriceInfo and ItemPriceInfo currency codes in all the ShippingGroups and CommerceItems, respectively. To do additional validation for currency codes, override this method to validate and then call this class' runProcess() method. This method requires that an Order and optionally a Locale object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap.

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 invokation

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), AmountInfo, OrderPriceInfo, TaxPriceInfo, ItemPriceInfo, ShippingPriceInfo