|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.commerce.payment.processor.ProcProcessPaymentGroup
public abstract class ProcProcessPaymentGroup
This is the base class which processors that would like to perform auth/debit/credit actions on a particular payment group can extend from. The intention is that this class should provide utility methods which would be applicable to all PaymentGroup auth/debit/credits. Concrete uses of this class can be seen in ProcProcessCreditCard.
ProcProcessCreditCard
,
ProcProcessGiftCertificate
,
ProcProcessStoreCredit
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
static int |
SUCCESS
The possible return value for this processor. |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
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 | |
---|---|
ProcProcessPaymentGroup()
Empty Constructor. |
Method Summary | |
---|---|
abstract PaymentStatus |
authorizePaymentGroup(PaymentManagerPipelineArgs pParams)
Method called to perform an authorization of a PaymentGroup. |
abstract PaymentStatus |
creditPaymentGroup(PaymentManagerPipelineArgs pParams)
Method called to perform a credit of a PaymentGroup. |
abstract PaymentStatus |
debitPaymentGroup(PaymentManagerPipelineArgs pParams)
Method called to perform a debit of a PaymentGroup. |
PaymentStatus |
decreaseAuthorizationForPaymentGroup(PaymentManagerPipelineArgs pParams)
Method called to perform a decrease in authorization for a payment group. |
int[] |
getRetCodes()
The possible return values for this processor. |
protected void |
invokeProcessorAction(PaymentManagerAction pProcessorAction,
PaymentManagerPipelineArgs pParams)
Method which can distribute a particular chain invocation to the correct method to invoke. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method is the one called by the pipelin chain. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
---|
public static java.lang.String CLASS_VERSION
public static final int SUCCESS
Constructor Detail |
---|
public ProcProcessPaymentGroup()
Method Detail |
---|
protected void invokeProcessorAction(PaymentManagerAction pProcessorAction, PaymentManagerPipelineArgs pParams) throws CommerceException
pParams
map using PipelineConstants.PAYMENT_STATUS
as the key.
pProcessorAction
- the action to perform. Should match
a value in atg.commerce.payment.ConstantspParams
- map of params handed to pipeline chain
CommerceException
- if an error occurspublic PaymentStatus decreaseAuthorizationForPaymentGroup(PaymentManagerPipelineArgs pParams) throws CommerceException
This implementations does nothing by default and returns null.
pParams
- params handed to pipeline processor
PaymentStatus
value
CommerceException
- if an error occurspublic abstract PaymentStatus authorizePaymentGroup(PaymentManagerPipelineArgs pParams) throws CommerceException
pParams
- params handed to pipeline processor
PaymentStatus
value
CommerceException
- if an error occurspublic abstract PaymentStatus debitPaymentGroup(PaymentManagerPipelineArgs pParams) throws CommerceException
pParams
- params handed to pipeline processor
PaymentStatus
value
CommerceException
- if an error occurspublic abstract PaymentStatus creditPaymentGroup(PaymentManagerPipelineArgs pParams) throws CommerceException
pParams
- params handed to pipeline processor
PaymentStatus
value
CommerceException
- if an error occurspublic int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
PipelineConstants.PAYMENT_PROC_ACTION
value from the pipeline and then call
invokeProcessorAction() with this values.
Classes will have to subclass this class in order to provide
meaningful implementations of the auth, debit and credit methods.
- Specified by:
runProcess
in interface PipelineProcessor
- Parameters:
pParam
- an Object
valuepResult
- a PipelineResult
value
- Returns:
- an
int
value
- Throws:
java.lang.Exception
- if an error occurs
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
int[]
value. This is
just the SUCCESS
value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |