|
|||||||||
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.ProcCreateCreditCardInfo
public class ProcCreateCreditCardInfo
This pipeline processor element is called to create generic
CreditCardInfo objects from instances of the CreditCard
payment group. It places them into the pipeline argument dictionary so
that downstream pipeline processors can retrieve them by calling
PaymentManagerPipelineArgs.getPaymentInfo()
.
This processor is designed so that the CreditCardInfo class can easily be
extended. See
"
and
setCreditCardInfoClass
""
for more information.
addDataToCreditCardInfo
"
CreditCardInfo
,
GenericCreditCardInfo
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 | |
---|---|
ProcCreateCreditCardInfo()
|
Method Summary | |
---|---|
protected void |
addDataToCreditCardInfo(Order pOrder,
CreditCard pPaymentGroup,
double pAmount,
PaymentManagerPipelineArgs pParams,
GenericCreditCardInfo pCreditCardInfo)
This method populates the CreditCardInfo object with
data. |
protected GenericCreditCardInfo |
getCreditCardInfo()
Factory method to create a new CreditCardInfo object. |
java.lang.String |
getCreditCardInfoClass()
Return the class to instantiate when creating a new CreditCardInfo object. |
int[] |
getRetCodes()
Return the possible return values for this processor. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Generate a CreditCardInfo object of the class specified by creditCardInfoClass , populate it with data from a
CreditCard payment group by calling
addDataToCreditCardInfo , and add it to the pipeline
argument dictionary so that downstream pipeline processors can access
it. |
void |
setCreditCardInfoClass(java.lang.String pCreditCardInfoClass)
Specify the class to instantiate when creating a new CreditCardInfo object. |
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 |
---|
public static java.lang.String CLASS_VERSION
public static final int SUCCESS
Constructor Detail |
---|
public ProcCreateCreditCardInfo()
Method Detail |
---|
public java.lang.String getCreditCardInfoClass()
public void setCreditCardInfoClass(java.lang.String pCreditCardInfoClass)
GenericCreditCardInfo
class is extended to
include more information, this property can be changed to reflect the
new class.
protected void addDataToCreditCardInfo(Order pOrder, CreditCard pPaymentGroup, double pAmount, PaymentManagerPipelineArgs pParams, GenericCreditCardInfo pCreditCardInfo)
CreditCardInfo
object with
data. If the additional data is required, a subclass of
GenericCreditCardInfo
can be created with additional
properties, the creditCardInfoClass
property can be
changed to specify the new class, and this method can be overridden to
add data for the new properties (or another pipeline processor could be
added after this processor to populate the additional properties).
pOrder
- The order being paid for.pPaymentGroup
- The payment group being processed.pAmount
- The amount being authorized, debited, or creditedpParams
- The parameter dictionary passed to this pipeline processorpCreditCardInfo
- An object that holds information understood by the credit
card payment processor.protected GenericCreditCardInfo getCreditCardInfo() throws java.lang.Exception
creditCardInfoClass
property, and must be a subclass
of atg.payment.creditcard.GenericCreditCardInfo
.
creditCardInfoClass
java.lang.Exception
- if any instantiation error occurs when creating the info objectpublic int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
creditCardInfoClass
, populate it with data from a
CreditCard
payment group by calling
addDataToCreditCardInfo
, and add it to the pipeline
argument dictionary so that downstream pipeline processors can access
it.
runProcess
in interface PipelineProcessor
pParam
- Parameter dictionary of type PaymentManagerPipelineArgs.pResult
- Pipeline result object, not used by this method.
java.lang.Exception
- If any error occurs creating or populating the credit card info object.public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |