atg.commerce.order.processor
Class ProcValidateShippingCostsForCheckout
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.logging.ApplicationLoggingImpl
atg.commerce.order.processor.ProcValidateShippingCostsForCheckout
- All Implemented Interfaces:
- ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor
public class ProcValidateShippingCostsForCheckout
- extends ApplicationLoggingImpl
- implements PipelineProcessor
This processor validates that all shipping costs are accounted for by a PaymentGroup.
Shipping costs are accounted for if there is only one PaymentGroup and it has no
Relationships, if the ShippingGroup has been assigned to a PaymentGroup, or if an
order level Relationship exists in the Order which covers the entire amount of the
Order.
Field Summary |
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
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)
This method validates that all ShippingGroup costs are accounted for. |
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, 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 |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
- Class version string
ProcValidateShippingCostsForCheckout
public ProcValidateShippingCostsForCheckout()
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
- This method validates that all ShippingGroup costs are accounted for. In order
to be accounted for there must either be one PaymentGroup in the Order with
no Relationships, an order level Relationship which covers the entire cost
of the order, or the ShippingGroup must be assigned to a PaymentGroup. If any
ShippingGroup's costs are not accounted for, then an error will be added to
pResult. To do additional validation, override this method, do the validation
and call this class' runProcess() method to do the default validation.
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 objectpResult
- 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)