atg.commerce.csr.returns.processor
Class ProcValidateRefundMethodAllocations
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.commerce.csr.returns.processor.ProcValidateRefundMethodAllocations
- All Implemented Interfaces:
- atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, PipelineProcessor, java.util.EventListener
public class ProcValidateRefundMethodAllocations
- extends GenericService
- implements PipelineProcessor
Validates the refund amounts allocated to the RefundMethods.
All validation errors are added to the PipelineResult object and the chain execution stopped.
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Method Summary |
int[] |
getRetCodes()
Returns an array of all the return codes that could be returned by this PipelineProcessor. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method runs the actual processor and does the work. |
protected void |
validateRefundAllocations(java.lang.Object pParam,
PipelineResult pResult)
Ensures that the amount allocated to each RefundMethod does not exceed its maximum refund amount
and that the total refund amount equals the total RefundMethod allocations. |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
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 |
CLASS_VERSION
public static final java.lang.String CLASS_VERSION
- See Also:
- Constant Field Values
mRetCodes
protected int[] mRetCodes
- Returns the valid return codes. This processor always returns
a status of 1 indicating successful completion.
ProcValidateRefundMethodAllocations
public ProcValidateRefundMethodAllocations()
getRetCodes
public int[] getRetCodes()
- Description copied from interface:
PipelineProcessor
- Returns an array of all the return codes that could be returned by this PipelineProcessor.
- Specified by:
getRetCodes
in interface PipelineProcessor
- Returns:
- an array of all the return codes that could be returned by this PipelineProcessor.
runProcess
public int runProcess(java.lang.Object pParam,
PipelineResult pResult)
throws java.lang.Exception
- Description copied from interface:
PipelineProcessor
- This method runs the actual processor and does the work. pParam is user data and
pResult is an object which contains result data. The return value of the method is
what determines what the next link to be executed is.
- Specified by:
runProcess
in interface PipelineProcessor
- Parameters:
pParam
- an optional user parameterpResult
- 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. STOP_CHAIN_EXECUTION
will notify the PipelineManager to stop execution. An unmapped value will throw a
RunProcessException.
- Throws:
java.lang.Exception
- See Also:
validateRefundAllocations(Object, PipelineResult)
validateRefundAllocations
protected void validateRefundAllocations(java.lang.Object pParam,
PipelineResult pResult)
- Ensures that the amount allocated to each RefundMethod does not exceed its maximum refund amount
and that the total refund amount equals the total RefundMethod allocations.
- Parameters:
pParam
- pResult
-