atg.commerce.fulfillment.processor

Class ProcHandleRetrievingOrder

java.lang.Object

atg.commerce.fulfillment.processor.ProcHandleRetrievingOrder

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleRetrievingOrder
extends java.lang.Object
implements PipelineProcessor

This processor loads the order by the id. If the order doesn't exist in the repository, it will be saved (a new order arrived). After the order is loaded, it's added to the Hashmap object that is then passed to other processors.

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

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The processor to retrieve order by its object 2 - The processor to retrieve order by its id
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Determines a mode an order should be retrieved from the db.

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

ProcHandleRetrievingOrder

public ProcHandleRetrievingOrder()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor to retrieve order by its object 2 - The processor to retrieve order by its id

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

Determines a mode an order should be retrieved from the db. This method requires that a JMS message 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 JMS 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)