atg.commerce.fulfillment.processor
Class ProcVerifyItemRelationshipForRemoval

java.lang.Object
  extended by atg.commerce.fulfillment.processor.ProcVerifyItemRelationshipForRemoval
All Implemented Interfaces:
PipelineProcessor

public class ProcVerifyItemRelationshipForRemoval
extends java.lang.Object
implements PipelineProcessor

This processor verifies if the item relatioship is in a state that allows it to be removed


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
ProcVerifyItemRelationshipForRemoval()
           
 
Method Summary
 int[] getRetCodes()
          Returns the valid return codes 1 - The processor completed
 int runProcess(java.lang.Object pParam, PipelineResult pResult)
          This processor verifies if the item relatioship is in a state that allows it to be removed 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

ProcVerifyItemRelationshipForRemoval

public ProcVerifyItemRelationshipForRemoval()
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
This processor verifies if the item relatioship is in a state that allows it to be removed 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)