atg.commerce.fulfillment.processor
Class ProcRetrieveOrderPendingShipMap

java.lang.Object
  atg.commerce.fulfillment.processor.ProcRetrieveOrderPendingShipMap

All Implemented Interfaces:

PipelineProcessor

public class ProcRetrieveOrderPendingShipMap
extends java.lang.Object
implements PipelineProcessor

This processor is executed as part of the HardgoodShipper to ship shipping groups that are in a PENDING_SHIPMENT state. It will return a HashMap object with orders whose shipping groups are ready to ship.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

Constructor Summary

ProcRetrieveOrderPendingShipMap()

Method Summary

int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected java.util.HashMap	retrieveOrderPendingShipMap(HardgoodFulfiller of, HardgoodShipper hs) Returns a HashMap whose ids are the order ids of orders that contain shipping groups and the values are the shipping group ids that are ready for shipment.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Returns a HashMap object with orders whose shipping groups are ready to ship This method requires that an OrderFulfiller object be supplied in pParam in a HashMap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcRetrieveOrderPendingShipMap

public ProcRetrieveOrderPendingShipMap()

Method Detail

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

Returns a HashMap object with orders whose shipping groups are ready to ship This method requires that an 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 OrderFulfiller object

pResult - 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)

retrieveOrderPendingShipMap

protected java.util.HashMap retrieveOrderPendingShipMap(HardgoodFulfiller of,
                                                        HardgoodShipper hs)

Returns a HashMap whose ids are the order ids of orders that contain shipping groups and the values are the shipping group ids that are ready for shipment. The default implementation uses the order repository to return all shipping groups whose state is PENDING_SHIPMENT.

Returns:

a HashMap where the keys are the order ids, and the values are a Set of the shipping group ids that belong.