atg.commerce.fulfillment.processor

Class ProcHandleOrderPendingShipMap

java.lang.Object

atg.commerce.fulfillment.processor.ProcHandleOrderPendingShipMap

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleOrderPendingShipMap
extends java.lang.Object
implements PipelineProcessor

This processor iterates through the Hashmap object with orders whose shipping groups are ready to ship. It will call to the chain to ship the groups.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ProcHandleOrderPendingShipMap()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChainToRun()
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Ships the shipping group by calling the corresponding chain.
void	setChainToRun(java.lang.String pChainToRun)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ProcHandleOrderPendingShipMap

public ProcHandleOrderPendingShipMap()

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.

getChainToRun

public java.lang.String getChainToRun()

setChainToRun

public void setChainToRun(java.lang.String pChainToRun)

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Ships the shipping group by calling the corresponding chain. 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)