atg.commerce.payment.processor

Class ProcCreateInStorePaymentInfo

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.payment.processor.ProcCreateInStorePaymentInfo

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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 ProcCreateInStorePaymentInfo
extends GenericService
implements PipelineProcessor

This pipeline processor element is called to create generic InStorePaymentInfo objects from instances of the InStorePayment payment group. It places them into the pipeline argument dictionary so that downstream pipeline processors can retrieve them by calling PaymentManagerPipelineArgs.getPaymentInfo().

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ProcCreateInStorePaymentInfo()

Method Summary

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.

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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

SUCCESS

public static final int SUCCESS

The possible return value for this processor.

See Also:

Constant Field Values

Constructor Detail

ProcCreateInStorePaymentInfo

public ProcCreateInStorePaymentInfo()

Method Detail

getInStorePaymentInfoClass

public java.lang.String getInStorePaymentInfoClass()

Return the class to instantiate when creating a new InStorePaymentInfo object.

setInStorePaymentInfoClass

public void setInStorePaymentInfoClass(java.lang.String pInStorePaymentInfoClass)

Specify the class to instantiate when creating a new InStorePaymentInfo object. If the GenericInStorePaymentInfo class is extended to include more information, this property can be changed to reflect the new class.

addDataToInStorePaymentInfo

protected void addDataToInStorePaymentInfo(Order pOrder,
                                           InStorePayment pPaymentGroup,
                                           double pAmount,
                                           PaymentManagerPipelineArgs pParams,
                                           GenericInStorePaymentInfo pInStorePaymentInfo)

This method populates the 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).

Parameters:

pOrder - The order being paid for.

pPaymentGroup - The payment group being processed.

pAmount - The amount being authorized, debited, or credited

pParams - The parameter dictionary passed to this pipeline processor

pInStorePaymentInfo - An object that holds information understood by the in store payment processor.

getInStorePaymentInfo

protected GenericInStorePaymentInfo getInStorePaymentInfo()
                                                   throws java.lang.Exception

Factory method to create a new InStorePaymentInfo object. The class that is created is that specified by the inStorePaymentInfoClass property, and must be a subclass of atg.payment.instorepayment.GenericInStorePaymentInfo.

Returns:

An object of the class specified by inStorePaymentInfoClass

Throws:

java.lang.Exception - if any instantiation error occurs when creating the info object

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 parameter

pResult - 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

getRetCodes

public int[] getRetCodes()

Return the possible return values for this processor. This processor always returns a success code.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.