atg.commerce.fulfillment.processor

Class ProcHandleItemRelationshipState

java.lang.Object

atg.commerce.fulfillment.processor.ProcHandleItemRelationshipState

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleItemRelationshipState
extends java.lang.Object
implements PipelineProcessor

This processor routes the item allocation procedure based on the relationship's state

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
ProcHandleItemRelationshipState()

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The processor to purchase in stock items 2 - The processor to purchase pre-ordered items 3 - The processor to purchase back-ordered items
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Gets the relationship's state to purchase in stock, pre-ordered or back-ordered items This method requires that a 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

ProcHandleItemRelationshipState

public ProcHandleItemRelationshipState()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor to purchase in stock items 2 - The processor to purchase pre-ordered items 3 - The processor to purchase back-ordered items

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

Gets the relationship's state to purchase in stock, pre-ordered or back-ordered items This method requires that a 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 a 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)