atg.commerce.fulfillment.processor
Class ProcAllocateItemRelationship

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

All Implemented Interfaces:

PipelineProcessor

public class ProcAllocateItemRelationship
extends java.lang.Object
implements PipelineProcessor

This processor allocates all inventory itemRelationships in the shipping group

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

ProcAllocateItemRelationship()

Method Summary

protected boolean	allocateShippingGroupItem(HardgoodFulfiller of, Order pOrder, ShippingGroupCommerceItemRelationship sgcir, java.util.List pModificationList) Deprecated. Use InventoryFulfiller signature when possible
protected boolean	allocateShippingGroupItem(atg.commerce.fulfillment.InventoryFulfiller of, Order pOrder, ShippingGroupCommerceItemRelationship sgcir, java.util.List pModificationList) Allocates the ItemRelationship from the shipping group
java.lang.String	getChainToRun()
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Allocates all inventory items Relationships in the shipping group 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

ProcAllocateItemRelationship

public ProcAllocateItemRelationship()

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

Allocates all inventory items Relationships in the shipping group 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)

allocateShippingGroupItem

protected boolean allocateShippingGroupItem(HardgoodFulfiller of,
                                            Order pOrder,
                                            ShippingGroupCommerceItemRelationship sgcir,
                                            java.util.List pModificationList)

Deprecated. Use InventoryFulfiller signature when possible

Backwards compatibility signature

allocateShippingGroupItem

protected boolean allocateShippingGroupItem(atg.commerce.fulfillment.InventoryFulfiller of,
                                            Order pOrder,
                                            ShippingGroupCommerceItemRelationship sgcir,
                                            java.util.List pModificationList)

Allocates the ItemRelationship from the shipping group