public class ProcCreateInStorePaymentInfo extends GenericService implements PipelineProcessor
PaymentManagerPipelineArgs.getPaymentInfo().
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 |
---|
ProcCreateInStorePaymentInfo() |
Modifier and Type | Method and Description |
---|---|
protected void |
addDataToInStorePaymentInfo(Order pOrder,
InStorePayment pPaymentGroup,
double pAmount,
PaymentManagerPipelineArgs pParams,
GenericInStorePaymentInfo pInStorePaymentInfo)
This method populates the
InStorePaymentInfo object with
data. |
protected GenericInStorePaymentInfo |
getInStorePaymentInfo()
Factory method to create a new InStorePaymentInfo object.
|
java.lang.String |
getInStorePaymentInfoClass()
Return the class to instantiate when creating a new InStorePaymentInfo object.
|
int[] |
getRetCodes()
Return the possible return values for this processor.
|
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method runs the actual processor and does the work.
|
void |
setInStorePaymentInfoClass(java.lang.String pInStorePaymentInfoClass)
Specify the class to instantiate when creating a new InStorePaymentInfo
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 getInStorePaymentInfoClass()
public void setInStorePaymentInfoClass(java.lang.String pInStorePaymentInfoClass)
GenericInStorePaymentInfo
class is extended to
include more information, this property can be changed to reflect the
new class.protected void addDataToInStorePaymentInfo(Order pOrder, InStorePayment pPaymentGroup, double pAmount, PaymentManagerPipelineArgs pParams, GenericInStorePaymentInfo pInStorePaymentInfo)
InStorePaymentInfo
object with
data. If the additional data is required, a subclass of
InStorePaymentInfo
can be created with additional
properties, the inStorePaymentInfoClass
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 processorpInStorePaymentInfo
- An object that holds information understood by the in store
payment processor.protected GenericInStorePaymentInfo getInStorePaymentInfo() throws java.lang.Exception
inStorePaymentInfoClass
property, and must be a subclass
of atg.payment.instorepayment.GenericInStorePaymentInfo
.inStorePaymentInfoClass
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
PipelineProcessor
runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other datajava.lang.Exception
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor