atg.commerce.order.processor
Class ProcValidateHardgoodShippingGroup

java.lang.Object
  atg.nucleus.logging.ApplicationLoggingImpl
      atg.commerce.order.processor.ProcValidateHardgoodShippingGroup

All Implemented Interfaces:

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

public class ProcValidateHardgoodShippingGroup
extends ApplicationLoggingImpl
implements PipelineProcessor

Validate a single instance of HardgoodShippingGroup at checkout time. This processor verifies that all required fields in a HardgoodShippingGroup are present and that they have acceptable values, to the extent that this can be determined in a generic way.

Field Summary

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

ProcValidateHardgoodShippingGroup()

Method Summary

java.lang.String	getLoggingIdentifier() Return the LoggingIdentifier used in log messages.
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
ShippingAddrValidator	getShippingAddressValidator()
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Verify that all required shipping adddress properties are provided in a HardgoodShippingGroup.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Set the LoggingIdentifier used in log messages.
void	setShippingAddressValidator(ShippingAddrValidator pShippingAddressValidator)
protected void	validateHardgoodShippingGroupFields(HardgoodShippingGroup hsg, PipelineResult pResult, java.util.ResourceBundle pResourceBundle) This method validates the HardgoodShippingGroup properties.

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, 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 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

ProcValidateHardgoodShippingGroup

public ProcValidateHardgoodShippingGroup()

Method Detail

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Set the LoggingIdentifier used in log messages.

Overrides:

setLoggingIdentifier in class ApplicationLoggingImpl

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Return the LoggingIdentifier used in log messages.

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl

setShippingAddressValidator

public void setShippingAddressValidator(ShippingAddrValidator pShippingAddressValidator)

getShippingAddressValidator

public ShippingAddrValidator getShippingAddressValidator()

getRetCodes

public int[] getRetCodes()

Description copied from interface: PipelineProcessor

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

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

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

runProcess

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

Verify that all required shipping adddress properties are provided in a HardgoodShippingGroup.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

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. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception

See Also:

ShippingAddrValidator

validateHardgoodShippingGroupFields

protected void validateHardgoodShippingGroupFields(HardgoodShippingGroup hsg,
                                                   PipelineResult pResult,
                                                   java.util.ResourceBundle pResourceBundle)

This method validates the HardgoodShippingGroup properties. By default validation is limited to checking the fields in the shipping address by calling validateShippingAddress.

Parameters:

hsg - a HardgoodShippingGroup object to validate