atg.commerce.fulfillment.processor

Class ProcHandleShippingGroupState

java.lang.Object

atg.commerce.fulfillment.processor.ProcHandleShippingGroupState

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleShippingGroupState
extends java.lang.Object
implements PipelineProcessor

This processor routes the execution resulted in an update of a shipping group based on the shipping group's new state value.

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

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The order remove completion processor 2 - The order completion processor 3 - The order failure processor 4 - The shipping of a shipping group processor 5 - The unsupported modification processor
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Executes an operation on an order after the shipping group's state has been changed This method requires that an Order and Modification 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

ProcHandleShippingGroupState

public ProcHandleShippingGroupState()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The order remove completion processor 2 - The order completion processor 3 - The order failure processor 4 - The shipping of a shipping group processor 5 - The unsupported modification processor

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

Executes an operation on an order after the shipping group's state has been changed This method requires that an Order and 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 an Order and 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)