atg.commerce.order.processor

Class ProcSetPaymentGroupAmount

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.ProcSetPaymentGroupAmount

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcSetPaymentGroupAmount
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor determines the values that need to be set into the amount field of a PaymentGroup. This processor iterates through all the Relationships determining the amounts to set into the PaymentGroups based on the Relationship type. Any amounts set in the amount property of a PaymentGroup will be overwritten here.

See Also:

PaymentGroup

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

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ProcSetPaymentGroupAmount()

Method Summary

Modifier and Type	Method and Description
protected void	addHashedError(PipelineResult pResult, java.lang.String pKey, java.lang.String pId, java.lang.Object pError) This method adds an error to the PipelineResult object.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
double	getMarginOfError() Returns the marginOfError
PricingTools	getPricingTools() PricingTools class used for rounding
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method determines the amount that needs to be set into the amount field of a PaymentGroup.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setMarginOfError(double pMarginOfError) Sets the marginOfError.
void	setPaymentGroupAmount(PaymentGroup pPaymentGroup, double pAmount) Sets the payment group amount to the given value.
void	setPaymentGroupAmount(PaymentGroup pPaymentGroup, double pAmount, java.lang.String pCurrencyCode) Sets the payment group amount to the given value.
void	setPricingTools(PricingTools pPricingTools)
void	setPricingToolsLocal(PricingTools pPricingTools) Sets a thread local version of PricingTools.

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

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

ProcSetPaymentGroupAmount

public ProcSetPaymentGroupAmount()

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.

getMarginOfError

public double getMarginOfError()

Returns the marginOfError

setMarginOfError

public void setMarginOfError(double pMarginOfError)

Sets the marginOfError. The margin of error determines what margin of error the double arithmatic will allow. The default value is 0.00001. To widen the margin, increase the value, to narrow it, decrease the value.

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Sets property LoggingIdentifier

Overrides:

setLoggingIdentifier in class ApplicationLoggingImpl

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Returns property LoggingIdentifier

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

setPricingToolsLocal

public void setPricingToolsLocal(PricingTools pPricingTools)

Sets a thread local version of PricingTools.

Parameters:

pPricingTools - pricing tools

getPricingTools

public PricingTools getPricingTools()

PricingTools class used for rounding

runProcess

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

This method determines the amount that needs to be set into the amount field of a PaymentGroup. This processor iterates through all the Relationships determining the amounts to set into the PaymentGroups based on the Relationship type. Any amounts set in the amount property of a PaymentGroup will be overwritten here. This method can be executed in one of two modes, return an error in pResult, or throw an exception when the first error is encountered. The default mode is to throw exceptions. To change it, add a RETURNERRORS entry into pParam with the value set to a Boolean object with a value of true. This method requires that an Order, OrderManager, and optionally a Locale object and a flag which instructs the processor to return errors 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, OrderManager, and optionally a Locale object and return errors flag.

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)

addHashedError

protected void addHashedError(PipelineResult pResult,
                              java.lang.String pKey,
                              java.lang.String pId,
                              java.lang.Object pError)

This method adds an error to the PipelineResult object. This method, rather than just storing a single error object in pResult, stores a Map of errors. This allows more than one error to be stored using the same key in the pResult object. pKey is used to reference a HashMap of errors in pResult. So, calling pResult.getError(pKey) will return an object which should be cast to a Map. Each entry within the map is keyed by pId and its value is pError.

Parameters:

pResult - the PipelineResult object supplied in runProcess()

pKey - the key to use to store the HashMap in the PipelineResult object

pId - the key to use to store the error message within the HashMap in the PipelineResult object

pError - the error object to store in the HashMap

See Also:

PipelineResult, runProcess(Object, PipelineResult)

setPaymentGroupAmount

public void setPaymentGroupAmount(PaymentGroup pPaymentGroup,
                                  double pAmount)

Sets the payment group amount to the given value. The value is always rounded first.

Parameters:

pPaymentGroup - The payment whose amount is being set

pAmount - The new amount

setPaymentGroupAmount

public void setPaymentGroupAmount(PaymentGroup pPaymentGroup,
                                  double pAmount,
                                  java.lang.String pCurrencyCode)

Sets the payment group amount to the given value. The value is always rounded first.

Parameters:

pPaymentGroup - The payment whose amount is being set

pAmount - The new amount

pCurrencyCode - currency code which is ussed for rounding operation