public class ProcCreateGiftCertificateInfo extends GenericService implements PipelineProcessor
PaymentManagerPipelineArgs.getPaymentInfo().
This processor is designed so that the GiftCertificateInfo class can
easily be extended. See
"setGiftCertificateInfoClass
"
and
"addDataToGiftCertificateInfo
"
for more information.
atg.payment.creditcard.GiftCertificateInfo
,
atg.payment.creditcard.GenericGiftCertificateInfo
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
static int |
SUCCESS
The possible return value for this processor.
|
SERVICE_INFO_KEY
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ProcCreateGiftCertificateInfo() |
Modifier and Type | Method and Description |
---|---|
protected void |
addDataToGiftCertificateInfo(Order pOrder,
GiftCertificate pPaymentGroup,
double pAmount,
PaymentManagerPipelineArgs pParams,
GenericGiftCertificateInfo pGiftCertificateInfo)
This method populates the
GiftCertificateInfo object with
data. |
protected GenericGiftCertificateInfo |
getGiftCertificateInfo()
Factory method to create a new GiftCertificateInfo object.
|
java.lang.String |
getGiftCertificateInfoClass()
Return the class to instantiate when creating a new GiftCertificateInfo
object.
|
int[] |
getRetCodes()
Return the possible return values for this processor.
|
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Generate a GiftCertificateInfo object of the class specified by
giftCertificateInfoClass , populate it with data from a
GiftCertificate payment group by calling
addDataToGiftCertificateInfo , and add it to the pipeline
argument dictionary so that downstream pipeline processors can access
it. |
void |
setGiftCertificateInfoClass(java.lang.String pGiftCertificateInfoClass)
Specify the class to instantiate when creating a new GiftCertificateInfo
object.
|
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final int SUCCESS
public java.lang.String getGiftCertificateInfoClass()
public void setGiftCertificateInfoClass(java.lang.String pGiftCertificateInfoClass)
GenericGiftCertificateInfo
class is extended to
include more information, this property can be changed to reflect the
new class.protected void addDataToGiftCertificateInfo(Order pOrder, GiftCertificate pPaymentGroup, double pAmount, PaymentManagerPipelineArgs pParams, GenericGiftCertificateInfo pGiftCertificateInfo)
GiftCertificateInfo
object with
data. If the additional data is required, a subclass of
GenericGiftCertificateInfo
can be created with additional
properties, the giftCertificateInfoClass
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 processorpGiftCertificateInfo
- An object that holds information understood by the gift
certificate payment processor.protected GenericGiftCertificateInfo getGiftCertificateInfo() throws java.lang.Exception
giftCertificateInfoClass
property, and must be a subclass
of atg.payment.giftcertificate.GenericGiftCertificateInfo
.giftCertificateInfoClass
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
giftCertificateInfoClass
, populate it with data from a
GiftCertificate
payment group by calling
addDataToGiftCertificateInfo
, 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 gift certificate info object.public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor