atg.commerce.fulfillment.processor
Class ProcVerifyShippingGroupForFulfillment
java.lang.Object
atg.commerce.fulfillment.processor.ProcVerifyShippingGroupForFulfillment
- All Implemented Interfaces:
- PipelineProcessor
public class ProcVerifyShippingGroupForFulfillment
- extends java.lang.Object
- implements PipelineProcessor
This method verifies that the shipping group to be fulfilled is in a state which allows it
to be fulfilled. If the shipping group is in an illegal state we will throw an exception.
Field Summary |
static java.lang.String |
CLASS_VERSION
Class version string |
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
ProcVerifyShippingGroupForFulfillment
public ProcVerifyShippingGroupForFulfillment()
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.
runProcess
public int runProcess(java.lang.Object pParam,
PipelineResult pResult)
throws java.lang.Exception
- This method verifies that the shipping group to be fulfilled is in a state which allows it
to be fulfilled. If the shipping group is in an illegal state we will throw an exception.
This method requires that an Order and OrderFulfiller 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 OrderFulfiller 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)
verifyShippingGroupFulfillment
protected void verifyShippingGroupFulfillment(HardgoodFulfiller of,
ShippingGroup pShippingGroup)
throws IllegalShippingGroupStateException
- This method verifies that the shipping group to be fulfilled is in a state which allows it
to be fulfilled. If the shipping group is in an illegal state we will throw an exception.
Illegal states include:
- Parameters:
pShippingGroup
- The shipping group we are verifying
- Throws:
IllegalShippingGroupStateException
- See Also:
atg.commerce.states.ShippingGroupStates#REMOVED,
,
atg.commerce.states.ShippingGroupStates#FAILED,
,
atg.commerce.states.ShippingGroupStates#NO_PENDING_ACTION,
,
ShippingGroupStates.PENDING_MERCHANT_ACTION
verifyShippingGroupFulfillment
protected void verifyShippingGroupFulfillment(atg.commerce.fulfillment.InventoryFulfiller of,
ShippingGroup pShippingGroup)
throws IllegalShippingGroupStateException
- Throws:
IllegalShippingGroupStateException