atg.commerce.fulfillment.processor
Class ProcAllocateShippingGroup

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

All Implemented Interfaces:

PipelineProcessor

public class ProcAllocateShippingGroup
extends java.lang.Object
implements PipelineProcessor

This processor allocates the inventory based shipping group by calling the corresponding chain

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

ProcAllocateShippingGroup()

Method Summary

java.lang.String	getChainToRun()
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed 2 - The processor failed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Allocates the inventory based shipping group by calling the corresponding pipeline chain This method requires that an Order and OrderFulfiller object be supplied in pParam in a HashMap.
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 java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcAllocateShippingGroup

public ProcAllocateShippingGroup()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor completed 2 - The processor failed

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

Allocates the inventory based shipping group by calling the corresponding pipeline chain 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 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)