atg.commerce.fulfillment.processor
Class ProcRemoveShipItemRelationship
java.lang.Object
atg.commerce.fulfillment.processor.ProcRemoveShipItemRelationship
- All Implemented Interfaces:
- PipelineProcessor
public class ProcRemoveShipItemRelationship
- extends java.lang.Object
- implements PipelineProcessor
This processor removes the item relationship from the shipping group by
reallocating its quantity in the inventory.
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)
This processor removes the item relationship from the shipping group by
reallocating its quantity in the inventory. |
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
ProcRemoveShipItemRelationship
public ProcRemoveShipItemRelationship()
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 processor removes the item relationship from the shipping group by
reallocating its quantity in the inventory.
This method requires that a JMS message and HardgoodFulfiller object be supplied
in pParam in a HashMap. Use the PipelineConstants class' static members to key
the objects in the HashMap.
If the item in the relationship is "PENDING_DELIVERY" then the stock level
of the item is increased using
InventoryManager.increaseStockLevel
and the sku Id is added to the pipeline parameter PipelineConstants.INVENTORYUPDATES
If the item in the relationship is "BACK_ORDERED" then the backorder level
of the item is increased using InventoryManager.increaseBackorderLevel
If the item in the relationship is "PRE_ORDERED" then the preorder level
of the item is increased using InventoryManager.increasePreorderLevel
- 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)
,
InventoryManager