atg.projects.store.fulfillment.processor
Class StoreProcFinishRemoveOrder

java.lang.Object
  extended by atg.commerce.fulfillment.processor.ProcFinishRemoveOrder
      extended by atg.projects.store.fulfillment.processor.StoreProcFinishRemoveOrder
All Implemented Interfaces:
atg.service.pipeline.PipelineProcessor

public class StoreProcFinishRemoveOrder
extends atg.commerce.fulfillment.processor.ProcFinishRemoveOrder

This processor is a part of "completeRemoveOrder" pipeline chain and is responsible for updating the AcknowledgedTransactionId and the state field of the order to indicate that this order has been canceled from CSC and requires resubmission to OMS.


Field Summary
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
StoreProcFinishRemoveOrder()
           
 
Method Summary
 atg.commerce.order.OrderManager getOrderManager()
           
 int[] getRetCodes()
          Returns the valid return codes.
 int runProcess(java.lang.Object pParam, atg.service.pipeline.PipelineResult pResult)
          Run process method.
 void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values
Constructor Detail

StoreProcFinishRemoveOrder

public StoreProcFinishRemoveOrder()
Method Detail

getRetCodes

public int[] getRetCodes()
Returns the valid return codes. 1 - The processor completed

Specified by:
getRetCodes in interface atg.service.pipeline.PipelineProcessor
Overrides:
getRetCodes in class atg.commerce.fulfillment.processor.ProcFinishRemoveOrder
Returns:
an integer array of the valid return codes.

getOrderManager

public atg.commerce.order.OrderManager getOrderManager()
Returns:
the order manager.

setOrderManager

public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
Parameters:
pOrderManager - - the order manage to set.

runProcess

public int runProcess(java.lang.Object pParam,
                      atg.service.pipeline.PipelineResult pResult)
               throws java.lang.Exception
Run process method.

Specified by:
runProcess in interface atg.service.pipeline.PipelineProcessor
Overrides:
runProcess in class atg.commerce.fulfillment.processor.ProcFinishRemoveOrder
Parameters:
pParam - - parameter
pResult - - result
Returns:
result code
Throws:
java.lang.Exception - if error occurs