|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.logging.ApplicationLoggingImpl atg.commerce.order.processor.ProcValidateShippingGroupsForCheckout
public class ProcValidateShippingGroupsForCheckout
This processor validates ShippingGroups before checking an Order out. The two main things which are checked for are that all CommerceItems in the Order are assigned to ShippingGroups and that all the required fields in all the ShippingGroups, regardless of type, are not null or empty String. The first check, that all CommerceItems are assigned to a ShippingGroup, first checks to see if there is only one ShippingGroup and it has no Relationships. If so, then all CommerceItems are implicitly assigned to that ShippingGroup. If there is more than one ShippingGroup or the ShippingGroup has at least one Relationship, then all CommerceItems must be assigned to one or more ShippingGroups. The CommerceItem's entire quantity must be assigned. The second check, that required fields are provided, iterates over all the ShippingGroups in the order and invokes a separate pipeline chain for each shipping group. The first processor in * that chain is responsible for examining the type of the shipping group and dispatching to an appropriate validation processor or processor chain that knows which fields are required for each shipping method.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected int[] |
mRetCodes
Returns the valid return codes. |
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 | |
---|---|
ProcValidateShippingGroupsForCheckout()
|
Method Summary | |
---|---|
protected void |
addHashedError(PipelineResult pResult,
java.lang.String pKey,
java.lang.String pId,
java.lang.Object pError)
This method adds an error to the PipelineResult object. |
java.lang.String |
getLoggingIdentifier()
Returns property LoggingIdentifier |
int[] |
getRetCodes()
Returns an array of all the return codes that could be returned by this PipelineProcessor. |
java.lang.String |
getValidateShippingGroupChain()
Get the name of the pipeline chain to run to validate each individual shipping group. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method performs two checks on all the ShippingGroups in the given Order. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
void |
setValidateShippingGroupChain(java.lang.String pValidateShippingGroupChain)
Set the name of the pipeline chain to run to validate each individual shipping group. |
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 |
---|
public static java.lang.String CLASS_VERSION
protected int[] mRetCodes
Constructor Detail |
---|
public ProcValidateShippingGroupsForCheckout()
Method Detail |
---|
public void setValidateShippingGroupChain(java.lang.String pValidateShippingGroupChain)
public java.lang.String getValidateShippingGroupChain()
public int[] getRetCodes()
PipelineProcessor
getRetCodes
in interface PipelineProcessor
public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- a HashMap which must contain an Order, an OrderManager, and optionally a
Locale objectpResult
- a PipelineResult object which stores any information which must
be returned from this method invokation
java.lang.Exception
- throws any exception back to the callerPipelineProcessor.runProcess(Object, PipelineResult)
protected void addHashedError(PipelineResult pResult, java.lang.String pKey, java.lang.String pId, java.lang.Object pError)
pResult
- the PipelineResult object supplied in runProcess()pKey
- the key to use to store the HashMap in the PipelineResult objectpId
- the key to use to store the error message within the HashMap in the
PipelineResult objectpError
- the error object to store in the HashMapPipelineResult
,
runProcess(Object, PipelineResult)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |