atg.commerce.fulfillment.processor

Class ProcCancelRemoveOrder

java.lang.Object

atg.commerce.fulfillment.processor.ProcCancelRemoveOrder

All Implemented Interfaces:

PipelineProcessor

public class ProcCancelRemoveOrder
extends java.lang.Object
implements PipelineProcessor

This processor cancels removing an order because of one or more its shipping groups `* or other components could not be removed

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

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected void	handleRemoveModification(FulfillerSystem of, java.util.HashMap pMap)
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Cancels removing the order after one of its components could not be removed.

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

ProcCancelRemoveOrder

public ProcCancelRemoveOrder()

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

Cancels removing the order after one of its components could not be removed. 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)

handleRemoveModification

protected void handleRemoveModification(FulfillerSystem of,
                                        java.util.HashMap pMap)
                                 throws java.lang.Exception

Throws:

java.lang.Exception