atg.projects.store.order.processor
Class ProcVerifyShippingAddresses

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.ProcVerifyOrderAddresses
              atg.projects.store.order.processor.ProcVerifyShippingAddresses

All Implemented Interfaces:

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

public class ProcVerifyShippingAddresses
extends atg.commerce.order.processor.ProcVerifyOrderAddresses

This class extends ProcVerifyOrderAddresses to verify only shipping-group addresses. This is so shipping address verification can take place immediately after the user specifies the shipping addresses, eliminating the UI awkwardness that takes place when a user is informed of an invalid shipping address after specifying billing information.

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	MSG_INVALID_ADDRESS
static java.lang.String	MSG_INVALID_ORDER_MANAGER_PARAMETER
static java.lang.String	MSG_INVALID_ORDER_PARAMETER

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

ProcVerifyShippingAddresses()
Creates a new ProcVerifyShippingAddresses object.

Method Summary

int	runProcess(java.lang.Object pParam, atg.service.pipeline.PipelineResult pResult) This method executes the address verification.

Methods inherited from class atg.commerce.order.processor.ProcVerifyOrderAddresses

addHashedError, cacheAddress, getAddressVerificationCache, getAddressVerificationProcessor, getCachedAddress, getLoggingIdentifier, getRetCodes, hasBeenVerified, isUseCache, setAddressVerificationCache, setAddressVerificationProcessor, setLoggingIdentifier, setUseCache, verifyAddress

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.

MSG_INVALID_ORDER_PARAMETER

public static final java.lang.String MSG_INVALID_ORDER_PARAMETER

See Also:

Constant Field Values

MSG_INVALID_ORDER_MANAGER_PARAMETER

public static final java.lang.String MSG_INVALID_ORDER_MANAGER_PARAMETER

See Also:

Constant Field Values

MSG_INVALID_ADDRESS

public static final java.lang.String MSG_INVALID_ADDRESS

See Also:

Constant Field Values

Constructor Detail

ProcVerifyShippingAddresses

public ProcVerifyShippingAddresses()

Creates a new ProcVerifyShippingAddresses object.

Method Detail

runProcess

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

This method executes the address verification. It searches through the ShippingGroup and PaymentGroup lists in the Order for HardgoodShippingGroup and CreditCard objects. It then gets the address from them and calls verifyAddress(). This method requires that an Order and an OrderManager 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 atg.service.pipeline.PipelineProcessor

Overrides:

runProcess in class atg.commerce.order.processor.ProcVerifyOrderAddresses

Parameters:

pParam - a HashMap which must contain an Order and OrderManager 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)