atg.commerce.fulfillment.processor

Class ProcModificationUnsupported

java.lang.Object

atg.commerce.fulfillment.processor.ProcModificationUnsupported

All Implemented Interfaces:

PipelineProcessor

public class ProcModificationUnsupported
extends java.lang.Object
implements PipelineProcessor

This processor simply fails the modification due its unsupported reasons.

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

Method Summary

Modifier and Type	Method and Description
boolean	getEmptyProcessor()
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Fails the modification since it is not supported This method requires that a Commerce message, Modification and OrderFulfiller object be supplied in pParam in a HashMap.
void	setEmptyProcessor(boolean pEmptyProcessor)

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

ProcModificationUnsupported

public ProcModificationUnsupported()

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.

setEmptyProcessor

public void setEmptyProcessor(boolean pEmptyProcessor)

getEmptyProcessor

public boolean getEmptyProcessor()

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Fails the modification since it is not supported This method requires that a Commerce message, Modification 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 a Commerce message 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)