atg.commerce.pricing.processor
Class PriceOrderTotal

java.lang.Object
  extended by atg.commerce.pricing.processor.PriceOrderTotal
All Implemented Interfaces:
PipelineProcessor

public class PriceOrderTotal
extends java.lang.Object
implements PipelineProcessor

A pipeline processor which is used to reprice an order. The order is repriced depending on the pricing operation command which is supplied. The operations which are supported are defined in the atg.commerce.pricing.PricingConstants interface. They include:

See Also:
PricingConstants

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
PriceOrderTotal()
          Constructs an instanceof PriceOrderTotal
 
Method Summary
 PricingTools getPricingTools()
          Returns property PricingTools
 int[] getRetCodes()
          Returns the valid return codes 1 - Order priced successfully 2 - Order pricing failed
 int runProcess(java.lang.Object pParam, PipelineResult pResult)
          Reprice the order by extracting out the necessary parameters from the Map which should be supplied as the param pParam.
 void setPricingTools(PricingTools pPricingTools)
          Sets property PricingTools
 
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

PriceOrderTotal

public PriceOrderTotal()
Constructs an instanceof PriceOrderTotal

Method Detail

setPricingTools

public void setPricingTools(PricingTools pPricingTools)
Sets property PricingTools


getPricingTools

public PricingTools getPricingTools()
Returns property PricingTools


runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception
Reprice the order by extracting out the necessary parameters from the Map which should be supplied as the param pParam. The following parameters should be in the map.

Specified by:
runProcess in interface PipelineProcessor
Parameters:
pParam - The object should be an instance of Map
pResult - the PipelineResult object which is used to return errors or other data
Returns:
an integer value which is mapped to the next processor to execute. SUCCESS: (1) OR STOP_CHAIN_EXECUTION_AND_ROLLBACK:
Throws:
java.lang.Exception

getRetCodes

public int[] getRetCodes()
Returns the valid return codes 1 - Order priced successfully 2 - Order pricing failed

Specified by:
getRetCodes in interface PipelineProcessor
Returns:
an array of all the return codes that could be returned by this PipelineProcessor.