atg.commerce.fulfillment.processor
Class ProcFinishShippingGroup
java.lang.Object
atg.commerce.fulfillment.processor.ProcFinishShippingGroup
- All Implemented Interfaces:
- PipelineProcessor
public class ProcFinishShippingGroup
- extends java.lang.Object
- implements PipelineProcessor
This processor will "ship" the shipping group by setting its states to completion
Field Summary |
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary |
int[] |
getRetCodes()
Returns the valid return codes
1 - The processor completed |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Ships the shipping group by setting its states to completion
This method requires that a JMS message and OrderFulfiller object be supplied
in pParam in a HashMap. |
void |
setShippedDate(HardgoodFulfiller of,
ShippingGroup pShippingGroup,
java.util.Date pShipDate,
java.util.List pModificationList)
This method sets the date when the shipping group shipped to the
given time. |
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
ProcFinishShippingGroup
public ProcFinishShippingGroup()
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
- Ships the shipping group by setting its states to completion
This method requires that a JMS message 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 a JMS message 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)
setShippedDate
public void setShippedDate(HardgoodFulfiller of,
ShippingGroup pShippingGroup,
java.util.Date pShipDate,
java.util.List pModificationList)
- This method sets the date when the shipping group shipped to the
given time. The property that gets set is
actualShipDate
- Parameters:
pShippingGroup
- The shipping group that shipped.pShipDate
- When the shipping group shipped.pModificationList
- Place to store new modifications.