atg.commerce.fulfillment.processor

Class ProcHandleModificationTargetType

java.lang.Object

atg.commerce.fulfillment.processor.ProcHandleModificationTargetType

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleModificationTargetType
extends java.lang.Object
implements PipelineProcessor

This processor routes the execution of the id target modification. It will call to different chains based on the modification target type (order, shipping group, relationship, commerce item)

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

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The order targeted modification 2 - The shipping groups targeted modification 3 - The item targeted modification 4 - The relationship modification 5 - The modification is not supported
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Routes the modification execution based on the modification target type.

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

ProcHandleModificationTargetType

public ProcHandleModificationTargetType()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The order targeted modification 2 - The shipping groups targeted modification 3 - The item targeted modification 4 - The relationship modification 5 - The modification is not supported

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

Routes the modification execution based on the modification target type. This method requires that a Modification 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 Modification 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)