atg.commerce.payment

Class PaymentManager

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.payment.PaymentManager

All Implemented Interfaces:

PaymentTypeProvider, 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, java.util.EventListener

public class PaymentManager
extends GenericService
implements PaymentTypeProvider

This class provides a set of methods for dealing with operations on PaymentGroups. All PaymentGroups have three types of operations which can be executed on them, authorize, debit, and credit. This class provides three methods that do each of these operations on any class which implements PaymentGroup. That is, there are authorize, credit and debit methods in this class. This class uses a pluggable configuration to allow for the ability to easily add new PaymentGroup types. There is a map that is maintained that maps between PaymentGroups and pipeline chain names. When any of the authorize, credit or debit methods are called a pipeline chain is obtained for the particular PaymentGroup and executed. So, to add a new PaymentGroup type all that should have to happen is to create a new PipelineChain where the processors of the pipelinechain know how to perform an authorize, credit or debit. Then, make an entry for this PaymentGroup to chainName mapping in the PaymentGroupToChainNameMap property. This class should not have to be overriden to add new PaymentGroup types. The methods which take a List of PaymentGroups do not need to be overridden because they just iterate over the list calling the same method as itself passing each PaymentGroup object.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	AUTH
static java.lang.String	CLASS_VERSION
protected static int	CREDIT
protected static int	DEBIT
protected static int	DECREASE_AUTH
protected java.util.Map<java.lang.String,PaymentType>	mSupportedPaymentTypesByPaymentGroupIdentifier Payment types supported by payment manager
static java.lang.String	NO_PAYMENT_TYPE_PROVIDER
protected static char	PAYMENT_TYPE_STRING_DELIMITER

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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
PaymentManager()

Method Summary

Modifier and Type	Method and Description
java.util.List	authorize(Order pOrder, java.util.List pPaymentGroups) This method authorizes payment for the given PaymentGroups.
void	authorize(Order pOrder, PaymentGroup pPaymentGroup) This method authorizes payment of the whole PaymentGroup.
void	authorize(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method performs three steps.
protected PaymentStatus	authorizeCreditCard(Order pOrder, CreditCard pPaymentGroup, double pAmount) Deprecated. use pipeline based authorization instead of methods directly in this class
protected PaymentStatus	authorizeGiftCertificate(Order pOrder, GiftCertificate pPaymentGroup, double pAmount) Deprecated. use pipeline based authorization instead of methods directly in this class
protected PaymentStatus	authorizeStoreCredit(Order pOrder, StoreCredit pPaymentGroup, double pAmount) Deprecated. use pipeline based authorization instead of methods directly in this class
protected void	createErrorPaymentStatus(int pListType, PaymentGroup pPaymentGroup, double pAmount, java.lang.String pErrorMessage) This method creates a PaymentStatusImpl object and adds it to the appropriate status list within the given PaymentGroup.
protected void	createIgnorePaymentStatus(int pListType, PaymentGroup pPaymentGroup, double pAmount) This method creates a PaymentStatusImpl object and adds it to the appropriate status list within the given PaymentGroup.
protected java.util.Map<java.lang.String,PaymentType>	createSupportedPaymentTypesMap() Generate the supported payment types in map form, keyed by payment group identifier.
java.util.List	credit(Order pOrder, java.util.List pPaymentGroups) This method credits payment for the given PaymentGroups.
void	credit(Order pOrder, PaymentGroup pPaymentGroup) This method credits payment of the whole PaymentGroup.
void	credit(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method performs three steps.
CreditCardStatus	creditCreditCard(CreditCardInfo pCreditCardInfo) Deprecated. use pipeline based debit instead of methods directly in this class
protected PaymentStatus	creditCreditCard(Order pOrder, CreditCard pPaymentGroup, double pAmount) Deprecated. use pipeline based credit instead of methods directly in this class
GiftCertificateStatus	creditGiftCertificate(GiftCertificateInfo pGiftCertificateInfo) Deprecated. use pipeline based credit instead of methods directly in this class
protected PaymentStatus	creditGiftCertificate(Order pOrder, GiftCertificate pPaymentGroup, double pAmount) Deprecated. use pipeline based credit instead of methods directly in this class
protected PaymentStatus	creditStoreCredit(Order pOrder, StoreCredit pPaymentGroup, double pAmount) Deprecated. use pipeline based credit instead of methods directly in this class
StoreCreditStatus	creditStoreCredit(StoreCreditInfo pStoreCreditInfo) Deprecated. use pipeline based credit instead of methods directly in this class
java.util.List	debit(Order pOrder, java.util.List pPaymentGroups) This method debits payment for the given PaymentGroups.
PipelineResult	debit(Order pOrder, PaymentGroup pPaymentGroup) This method debits the entire amount of the pPaymentGroup.
PipelineResult	debit(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method performs three steps.
protected PaymentStatus	debitCreditCard(Order pOrder, CreditCard pPaymentGroup, double pAmount) Deprecated. use pipeline based debit instead of methods directly in this class
protected PaymentStatus	debitGiftCertificate(Order pOrder, GiftCertificate pPaymentGroup, double pAmount) Deprecated. use pipeline based debit instead of methods directly in this class
protected PaymentStatus	debitStoreCredit(Order pOrder, StoreCredit pPaymentGroup, double pAmount) Deprecated. use pipeline based debit instead of methods directly in this class
void	decreaseAuthorization(Order pOrder, PaymentGroup pPaymentGroup, double pDecreaseAmount)
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
void	expireGiftCertificateAuthorization(Order pOrder, GiftCertificate pPaymentGroup, double pAmount) This method expires authorization for a given gift certificate PaymentGroup for the amount that is passed in.
void	expireStoreCreditAuthorization(Order pOrder, StoreCredit pPaymentGroup, double pAmount) This method expires authorization for a given StoreCredit PaymentGroup for the amount that is passed in.
protected java.lang.String	getAuthorizationChainName(PaymentGroup pPaymentGroup) Obtain a pipeline chain that can authorize the pPaymentGroup.
protected java.lang.String	getChainName(PaymentGroup pPaymentGroup) This method provides a mechanism by which to obtain a PipelineChain name from a given payment group.
CreditCardProcessor	getCreditCardProcessor() Returns the creditCardProcessor
protected java.lang.String	getCreditChainName(PaymentGroup pPaymentGroup) Obtain a pipeline chain that can credit the pPaymentGroup.
protected java.lang.String	getDebitChainName(PaymentGroup pPaymentGroup) Obtain a pipeline chain that can debit the pPaymentGroup.
protected java.lang.String	getDecreaseAuthorizationChainName(PaymentGroup pPaymentGroup) Obtain a pipeline chain that can decrease the authroization amount on the pPaymentGroup.
GiftCertificateProcessor	getGiftCertificateProcessor() Returns the GiftCertificateProcessor
protected PaymentType	getGroupPaymentType(java.lang.String pPaymentGroupIdentifier) Selects an already generated payment type object corresponding to the payment group identifier passed in.
boolean	getIgnoreTransactionsWithZeroAmount() Returns property ignoreTransactionsWithZeroAmount
boolean	getIncludePaymentGroupsWithoutOrderRelationship() Return flag stating whether or not to include payment types for payment groups which have no explicit relationship to the current order.
InStorePaymentProcessor	getInStorePaymentProcessor() Returns the inStorePaymentProcessor
PaymentStatus	getLastAuthorizationStatus(PaymentGroup pPaymentGroup) This method returns the last PaymentStatus object in the authorizationStatus list of the given PaymentGroup
PaymentStatus	getLastDebitStatus(PaymentGroup pPaymentGroup) This method returns the last PaymentStatus object in the debitStatus list of the given PaymentGroup
OrderManager	getOrderManager() Returns the orderManager
ServiceMap	getPaymentGroupIdentifierToPaymentTypeProvider() Retrieves a map which associates payment group identifiers with components which can generate the payment types associated with that group.
PaymentGroupManager	getPaymentGroupManager() Retrieve the payment group manager property.
java.util.Properties	getPaymentGroupToChainNameMap() Return the PaymentGroupToChainNameMap property.
PaymentType	getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup) Get a payment type object for a specific payment group which has a payment amount greater than zero.
PaymentType	getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier, java.lang.String pRemainderOfPaymentTypeString) Create a payment type object based upon a formatted string.
java.util.Set<PaymentType>	getPaymentTypes(Order pOrder) Get a set of payment type objects associated with an order.
java.util.Set<PaymentType>	getPaymentTypes(java.util.Set<java.lang.String> pPaymentTypeStrings) Get payment type objects from a set of payment type strings.
PipelineManager	getPipelineManager() Return the PipelineManager property.
PricingTools	getPricingTools() PricingTools is used to round amounts during comparisons.
StoreCreditProcessor	getStoreCreditProcessor() Returns property StoreCreditProcessor
java.util.Set<PaymentType>	getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier)
boolean	isAmountTooHigh(double pAmountSoFar, double pNewAmount, PaymentGroup pPaymentGroup) This method will add pAmountSoFar and pNewAmount.
boolean	isAmountTooHigh(double pAmountSoFar, double pNewAmount, PaymentGroup pPaymentGroup, java.lang.String pCurrencyCode) This method will add pAmountSoFar and pNewAmount.
protected void	postProcessAuthorize(PaymentGroup pPaymentGroup, PaymentStatus pStatus, double pAmount) This method executes post processing after an authorize() call to a payment processor.
protected void	postProcessCredit(PaymentGroup pPaymentGroup, PaymentStatus pStatus, double pAmount) This method executes post processing after a credit() call to a payment processor.
protected void	postProcessDebit(PaymentGroup pPaymentGroup, PaymentStatus pStatus, double pAmount) This method executes post processing after a debit() call to a payment processor.
protected void	postProcessDecreaseAuthorization(PaymentGroup pPaymentGroup, PaymentStatus pStatus, double pDecreaseAmount) This method executes post processing after an decreateAuthorize() call to a payment processor.
protected void	preProcessAuthorize(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method executes pre processing before an authorize() call to a payment processor.
protected void	preProcessCredit(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method executes pre processing before a credit() call to a payment processor.
protected void	preProcessDebit(Order pOrder, PaymentGroup pPaymentGroup, double pAmount) This method executes pre processing before a debit() call to a payment processor.
protected void	preProcessDecreaseAuthorization(Order pOrder, PaymentGroup pPaymentGroup, double pDecreaseAmount) This method executes pre processing before an decreaseAuthorization() call to a payment processor.
java.util.List<PaymentType>	retrieveAllSupportedPaymentTypes() Retrieves a list of all supported payment types in the system.
protected PipelineResult	runProcessorChain(java.lang.String pChainName, PaymentManagerPipelineArgs pParameters) Utility method to run a pipeline chain.
void	setCreditCardProcessor(CreditCardProcessor pCreditCardProcessor) Sets the creditCardProcessor
void	setGiftCertificateProcessor(GiftCertificateProcessor pGiftCertificateProcessor) Sets the GiftCertificateProcessor
void	setIgnoreTransactionsWithZeroAmount(boolean pIgnoreTransactionsWithZeroAmount) Sets property ignoreTransactionsWithZeroAmount
void	setIncludePaymentGroupsWithoutOrderRelationship(boolean pIncludePaymentGroupsWithoutOrderRelationship) Set a flag stating whether or not to include payment types for payment groups which have no explicit relationship to the current order.
void	setInStorePaymentProcessor(InStorePaymentProcessor pInStorePaymentProcessor) Sets the inStorePaymentProcessor
void	setOrderManager(OrderManager pOrderManager) Sets the orderManager
void	setPaymentGroupIdentifierToPaymentTypeProvider(ServiceMap pPaymentGroupIdentifierToPaymentTypeProvider) Set a service map which associates types of payment group with components which can generate the types of payment associated with that group.
void	setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager) Set the payment group manager property.
void	setPaymentGroupToChainNameMap(java.util.Properties pPaymentGroupToChainNameMap) Set the PaymentGroupToChainNameMap property.
void	setPipelineManager(PipelineManager pPipelineManager) Set the PipelineManager property.
void	setPricingTools(PricingTools pPricingTools)
void	setStoreCreditProcessor(StoreCreditProcessor pStoreCreditProcessor) Sets property StoreCreditProcessor

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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

AUTH

protected static final int AUTH

See Also:

Constant Field Values

DEBIT

protected static final int DEBIT

See Also:

Constant Field Values

CREDIT

protected static final int CREDIT

See Also:

Constant Field Values

DECREASE_AUTH

protected static final int DECREASE_AUTH

See Also:

Constant Field Values

PAYMENT_TYPE_STRING_DELIMITER

protected static final char PAYMENT_TYPE_STRING_DELIMITER

See Also:

Constant Field Values

NO_PAYMENT_TYPE_PROVIDER

public static final java.lang.String NO_PAYMENT_TYPE_PROVIDER

See Also:

Constant Field Values

mSupportedPaymentTypesByPaymentGroupIdentifier

protected java.util.Map<java.lang.String,PaymentType> mSupportedPaymentTypesByPaymentGroupIdentifier

Payment types supported by payment manager

Constructor Detail

PaymentManager

public PaymentManager()

Method Detail

getPipelineManager

public PipelineManager getPipelineManager()

Return the PipelineManager property.

Returns:

the PipelineManager

setPipelineManager

public void setPipelineManager(PipelineManager pPipelineManager)

Set the PipelineManager property.

Parameters:

pPipelineManager -

getPaymentGroupToChainNameMap

public java.util.Properties getPaymentGroupToChainNameMap()

Return the PaymentGroupToChainNameMap property.

Returns:

the PaymentGroupToChainNameMap

setPaymentGroupToChainNameMap

public void setPaymentGroupToChainNameMap(java.util.Properties pPaymentGroupToChainNameMap)

Set the PaymentGroupToChainNameMap property.

Parameters:

pPaymentGroupToChainNameMap -

getCreditCardProcessor

public CreditCardProcessor getCreditCardProcessor()

Returns the creditCardProcessor

Returns:

the creditCardProcessor

setCreditCardProcessor

public void setCreditCardProcessor(CreditCardProcessor pCreditCardProcessor)

Sets the creditCardProcessor

Parameters:

pCreditCardProcessor - the creditCardProcessor to set

getGiftCertificateProcessor

public GiftCertificateProcessor getGiftCertificateProcessor()

Returns the GiftCertificateProcessor

Returns:

returns the GiftCertificateProcessor

setGiftCertificateProcessor

public void setGiftCertificateProcessor(GiftCertificateProcessor pGiftCertificateProcessor)

Sets the GiftCertificateProcessor

Parameters:

pGiftCertificateProcessor - the GiftCertificateProcessor to set

getStoreCreditProcessor

public StoreCreditProcessor getStoreCreditProcessor()

Returns property StoreCreditProcessor

Returns:

returns property StoreCreditProcessor

setStoreCreditProcessor

public void setStoreCreditProcessor(StoreCreditProcessor pStoreCreditProcessor)

Sets property StoreCreditProcessor

Parameters:

pStoreCreditProcessor - the value to set for property StoreCreditProcessor

getInStorePaymentProcessor

public InStorePaymentProcessor getInStorePaymentProcessor()

Returns the inStorePaymentProcessor

Returns:

the inStorePaymentProcessor

setInStorePaymentProcessor

public void setInStorePaymentProcessor(InStorePaymentProcessor pInStorePaymentProcessor)

Sets the inStorePaymentProcessor

Parameters:

pInStorePaymentProcessor - the inStorePaymentProcessor to set

getOrderManager

public OrderManager getOrderManager()

Returns the orderManager

Returns:

returns the orderManager

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets the orderManager

Parameters:

pOrderManager - the OrderManager to set

getIgnoreTransactionsWithZeroAmount

public boolean getIgnoreTransactionsWithZeroAmount()

Returns property ignoreTransactionsWithZeroAmount

Returns:

returns property ignoreTransactionsWithZeroAmount

setIgnoreTransactionsWithZeroAmount

public void setIgnoreTransactionsWithZeroAmount(boolean pIgnoreTransactionsWithZeroAmount)

Sets property ignoreTransactionsWithZeroAmount

Parameters:

pIgnoreTransactionsWithZeroAmount - the value to set for property ignoreTransactionsWithZeroAmount

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

getPricingTools

public PricingTools getPricingTools()

PricingTools is used to round amounts during comparisons.

getPaymentGroupIdentifierToPaymentTypeProvider

public ServiceMap getPaymentGroupIdentifierToPaymentTypeProvider()

Retrieves a map which associates payment group identifiers with components which can generate the payment types associated with that group. The map is not expected to contain null values.

Returns:

A map associating payment group identifiers with payment type providers.

setPaymentGroupIdentifierToPaymentTypeProvider

public void setPaymentGroupIdentifierToPaymentTypeProvider(ServiceMap pPaymentGroupIdentifierToPaymentTypeProvider)

Set a service map which associates types of payment group with components which can generate the types of payment associated with that group.

Parameters:

pPaymentGroupIdentifierToPaymentTypeProvider - the map of payment group types to payment type providers to use. The map is not expected to contain null values.

getPaymentGroupManager

public PaymentGroupManager getPaymentGroupManager()

Retrieve the payment group manager property.

Returns:

an instance of PaymentGroupManager.

setPaymentGroupManager

public void setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager)

Set the payment group manager property.

Parameters:

pPaymentGroupManager - The payment group manager to use.

getIncludePaymentGroupsWithoutOrderRelationship

public boolean getIncludePaymentGroupsWithoutOrderRelationship()

Return flag stating whether or not to include payment types for payment groups which have no explicit relationship to the current order.

Returns:

a boolean stating whether payment groups without relationships should be considered or not.

See Also:

getPaymentTypes(Order pOrder)

setIncludePaymentGroupsWithoutOrderRelationship

public void setIncludePaymentGroupsWithoutOrderRelationship(boolean pIncludePaymentGroupsWithoutOrderRelationship)

Set a flag stating whether or not to include payment types for payment groups which have no explicit relationship to the current order.

Parameters:

pIncludePaymentGroupsWithoutOrderRelationship - A boolean stating whether payment groups without any relationship to the order should be considered or not.

See Also:

getPaymentTypes(Order pOrder)

createErrorPaymentStatus

protected void createErrorPaymentStatus(int pListType,
                                        PaymentGroup pPaymentGroup,
                                        double pAmount,
                                        java.lang.String pErrorMessage)

This method creates a PaymentStatusImpl object and adds it to the appropriate status list within the given PaymentGroup. This is a convenience method for creating status objects when an error occurs.

Parameters:

pPaymentGroup - the PaymentGroup to authorize

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is neither a CreditCard or GiftCertificate

See Also:

CreditCardProcessor, GiftCertificateProcessor

createIgnorePaymentStatus

protected void createIgnorePaymentStatus(int pListType,
                                         PaymentGroup pPaymentGroup,
                                         double pAmount)

This method creates a PaymentStatusImpl object and adds it to the appropriate status list within the given PaymentGroup. This is a convenience method for creating status objects when a PaymentGroup is ignored.

Parameters:

pPaymentGroup - the PaymentGroup to authorize

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is neither a CreditCard or GiftCertificate

See Also:

CreditCardProcessor, GiftCertificateProcessor

preProcessDecreaseAuthorization

protected void preProcessDecreaseAuthorization(Order pOrder,
                                               PaymentGroup pPaymentGroup,
                                               double pDecreaseAmount)
                                        throws CommerceException

This method executes pre processing before an decreaseAuthorization() call to a payment processor.

Parameters:

pOrder - the Order that the PaymentGroup exists in

pPaymentGroup - the PaymentGroup to be decreased in authorization

pDecreaseAmount - the amount by which the amount is decreasing

Throws:

CommerceException

decreaseAuthorization

public void decreaseAuthorization(Order pOrder,
                                  PaymentGroup pPaymentGroup,
                                  double pDecreaseAmount)
                           throws CommerceException

Throws:

CommerceException

postProcessDecreaseAuthorization

protected void postProcessDecreaseAuthorization(PaymentGroup pPaymentGroup,
                                                PaymentStatus pStatus,
                                                double pDecreaseAmount)
                                         throws CommerceException

This method executes post processing after an decreateAuthorize() call to a payment processor.

Parameters:

pPaymentGroup - the PaymentGroup which was decreased in authroization.

pStatus - the PaymentStatus object returned from the call of the payment processor

pDecreaseAmount - the amount by which the authorization amount is decreasing

Throws:

CommerceException

authorize

public void authorize(Order pOrder,
                      PaymentGroup pPaymentGroup)
               throws CommerceException

This method authorizes payment of the whole PaymentGroup. If pPaymentGroup is a CreditCard, then the authorize method in the creditCardProcessor object which is set is called, if pPaymentGroup is a GiftCertificate, then the authorize method in the giftCertificateProcessor object which is set is called, if pPaymentGroup is a StoreCredit, then the authorize method in the storeCreditProcessor object which is set is called. Override this method to handle other types of PaymentGroups. To determine if the authorization succeeded or failed, retrieve the last PaymentStatus object in the authorizationStatus List property of the PaymentGroup and check the transactionSuccess and errorMessage properties.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to authorize

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is neither a CreditCard or GiftCertificate

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

authorize

public void authorize(Order pOrder,
                      PaymentGroup pPaymentGroup,
                      double pAmount)
               throws CommerceException

This method performs three steps. It first calls the preProcessAuthorize method to perform any pre-processing. Next, it actually performs an authorization by calling a pipeline chain. The name of the chain to execute is determined by calling the getAuthorizationChainName method. The following entries are added to the Map of parameters handed to the pipeline chain

• PipelineConstants.ORDER
• PipelineConstants.PAYMENT_GROUP
• PipelineConstants.AMOUNT
• PipelineConstants.PAYMENT_GROUP_ACTION

Finally, the postProcessAuthorize method is called.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to authorize

pAmount - the amount to authorize

Throws:

PaymentException - if an error occured while authorizing

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

authorize

public java.util.List authorize(Order pOrder,
                                java.util.List pPaymentGroups)
                         throws CommerceException

This method authorizes payment for the given PaymentGroups. It iterates over the List calling the authorize(PaymentGroup) method in this class. The caller needs to check whether the returned List contains any ids which specify the PaymentGroups which failed authorization. Details of the failure can be found in authorizationStatus property of the PaymentGroup object.

Parameters:

pOrder - the Order which contains the PaymentGroups

pPaymentGroups - a list of PaymentGroups to authorize

Returns:

the list of PaymentGroup ids which failed to be authorized or an empty List if there were no failures

Throws:

InvalidParameterException - if pPaymentGroups is null

CommerceException

See Also:

authorize(Order, PaymentGroup)

debit

public PipelineResult debit(Order pOrder,
                            PaymentGroup pPaymentGroup)
                     throws CommerceException

This method debits the entire amount of the pPaymentGroup. This is done by calling the debit method that takes an additional amount parameter and handing it pPaymentGroup.getAmount(). To determine if the debit succeeded or failed, retrieve the last PaymentStatus object in the debitStatus List property of the PaymentGroup and check the transactionSuccess and errorMessage properties.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to debit

Throws:

PaymentException - if an error occured while debiting or pPaymentGroup is neither a CreditCard or GiftCertificate

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

debit

public PipelineResult debit(Order pOrder,
                            PaymentGroup pPaymentGroup,
                            double pAmount)
                     throws CommerceException

This method performs three steps. It first calls the preProcessDebit method to perform any pre-processing. Next, it actually performs a debit by calling a pipeline chain. The name of the chain to execute is determined by calling the getDebitChainName method. The following entries are added to the Map of parameters handed to the pipeline chain

• PipelineConstants.ORDER
• PipelineConstants.PAYMENT_GROUP
• PipelineConstants.AMOUNT
• PipelineConstants.PAYMENT_GROUP_ACTION

Finally, the postProcessDebit method is called. To determine if the debit succeeded or failed, retrieve the last PaymentStatus object in the debitStatus List property of the PaymentGroup and check the transactionSuccess and errorMessage properties.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to debit

Throws:

PaymentException - if an error occured while debiting

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

debit

public java.util.List debit(Order pOrder,
                            java.util.List pPaymentGroups)
                     throws CommerceException

This method debits payment for the given PaymentGroups. It iterates over the List calling the debit(PaymentGroup) method in this class. The caller needs to check whether the returned List contains any ids which specify the PaymentGroups which failed debiting. Details of the failure can be found in debitStatus property of the PaymentGroup object.

Parameters:

pOrder - the Order which contains the PaymentGroups

pPaymentGroups - a list of PaymentGroups to debit

Returns:

the list of PaymentGroup ids which failed to be debited or an empty List if there were no failures

Throws:

InvalidParameterException - if pPaymentGroups is null

CommerceException

See Also:

debit(Order, PaymentGroup)

credit

public void credit(Order pOrder,
                   PaymentGroup pPaymentGroup)
            throws CommerceException

This method credits payment of the whole PaymentGroup. When this method is called the amount in the PaymentGroup is credited to the user's account. This is done by calling the credit method that takes an amount parameter. This amount is obtained from the pPaymentGroup. To determine if the credit succeeded or failed, retrieve the last PaymentStatus object in the creditStatus List property of the PaymentGroup and check the transactionSuccess and errorMessage properties.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to credit

Throws:

PaymentException - if an error occured while crediting or pPaymentGroup is neither a CreditCard or GiftCertificate

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

credit

public void credit(Order pOrder,
                   PaymentGroup pPaymentGroup,
                   double pAmount)
            throws CommerceException

This method performs three steps. It first calls the preProcessCredit method to perform any pre-processing. Next, it actually performs a credit by calling a pipeline chain. The name of the chain to execute is determined by calling the getCreditChainName method. The following entries are added to the Map of parameters handed to the pipeline chain

• PipelineConstants.ORDER
• PipelineConstants.PAYMENT_GROUP
• PipelineConstants.AMOUNT
• PipelineConstants.PAYMENT_GROUP_ACTION

Finally, the postProcessCredit method is called. To determine if the credit succeeded or failed, retrieve the last PaymentStatus object in the creditStatus List property of the PaymentGroup and check the transactionSuccess and errorMessage properties.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup to credit

pAmount - the amount to credit to this PaymentGroup

Throws:

PaymentException - if an error occured while crediting or pPaymentGroup is neither a CreditCard or GiftCertificate

CommerceException

See Also:

CreditCardProcessor, GiftCertificateProcessor, StoreCreditProcessor

credit

public java.util.List credit(Order pOrder,
                             java.util.List pPaymentGroups)
                      throws CommerceException

This method credits payment for the given PaymentGroups. It iterates over the List calling the credit(PaymentGroup) method in this class. The caller needs to check whether the returned List contains any ids which specify the PaymentGroups which failed crediting. Details of the failure can be found in creditStatus property of the PaymentGroup object.

Parameters:

pOrder - the Order which contains the PaymentGroups

pPaymentGroups - a list of PaymentGroups to credit

Returns:

the list of PaymentGroup ids which failed to be credited or an empty List if there were no failures

Throws:

InvalidParameterException - if pPaymentGroups is null

CommerceException

See Also:

credit(Order, PaymentGroup)

authorizeCreditCard

protected PaymentStatus authorizeCreditCard(Order pOrder,
                                            CreditCard pPaymentGroup,
                                            double pAmount)
                                     throws CommerceException

Deprecated. use pipeline based authorization instead of methods directly in this class

This method authorizes payment for a given credit card PaymentGroup for the amount that is passed in.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the credit card PaymentGroup on which to authorize

pAmount - the amount to be authorized on the PaymentGroup

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is neither a CreditCard or GiftCertificate.

CommerceException

authorizeGiftCertificate

protected PaymentStatus authorizeGiftCertificate(Order pOrder,
                                                 GiftCertificate pPaymentGroup,
                                                 double pAmount)
                                          throws CommerceException

Deprecated. use pipeline based authorization instead of methods directly in this class

This method authorizes payment for a given gift certificate PaymentGroup for the amount that is passed in.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the gift certificate PaymentGroup on which to authorize

pAmount - the amount to be authorized on the PaymentGroup

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is not a GiftCertificate.

CommerceException

authorizeStoreCredit

protected PaymentStatus authorizeStoreCredit(Order pOrder,
                                             StoreCredit pPaymentGroup,
                                             double pAmount)
                                      throws CommerceException

Deprecated. use pipeline based authorization instead of methods directly in this class

This method authorizes payment for a given StoreCredit PaymentGroup for the amount that is passed in.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the StoreCredit PaymentGroup on which to authorize

pAmount - the amount to be authorized on the PaymentGroup

Throws:

PaymentException - if an error occured while authorizing or pPaymentGroup is not a StoreCredit.

CommerceException

expireGiftCertificateAuthorization

public void expireGiftCertificateAuthorization(Order pOrder,
                                               GiftCertificate pPaymentGroup,
                                               double pAmount)
                                        throws CommerceException

This method expires authorization for a given gift certificate PaymentGroup for the amount that is passed in.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the gift certificate PaymentGroup on which to expire authorization

pAmount - the amount to be expired on the PaymentGroup

Throws:

PaymentException - if an error occured while expiring the authorization or pPaymentGroup is not a GiftCertificate.

CommerceException

expireStoreCreditAuthorization

public void expireStoreCreditAuthorization(Order pOrder,
                                           StoreCredit pPaymentGroup,
                                           double pAmount)
                                    throws CommerceException

This method expires authorization for a given StoreCredit PaymentGroup for the amount that is passed in.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the StoreCredit PaymentGroup on which to expire authorization

pAmount - the amount to be expired on the PaymentGroup

Throws:

PaymentException - if an error occured while expiring the authorization or pPaymentGroup is not a StoreCredit.

CommerceException

debitCreditCard

protected PaymentStatus debitCreditCard(Order pOrder,
                                        CreditCard pPaymentGroup,
                                        double pAmount)
                                 throws CommerceException

Deprecated. use pipeline based debit instead of methods directly in this class

This method will debit a credit card for the amount that is passed into pAmount.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup against which we are debitting

pAmount - the amount to debit the PaymentGroup

Throws:

PaymentException - if an error occured while debiting or if the pPaymentGroup passed in is invalid.

CommerceException

debitGiftCertificate

protected PaymentStatus debitGiftCertificate(Order pOrder,
                                             GiftCertificate pPaymentGroup,
                                             double pAmount)
                                      throws CommerceException

Deprecated. use pipeline based debit instead of methods directly in this class

This method will debit a gift certificate for the amount that is passed into pAmount.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup against which we are debitting

pAmount - the amount to debit the PaymentGroup

Throws:

PaymentException - if an error occured while debiting or if the pPaymentGroup passed in is invalid.

CommerceException

debitStoreCredit

protected PaymentStatus debitStoreCredit(Order pOrder,
                                         StoreCredit pPaymentGroup,
                                         double pAmount)
                                  throws CommerceException

Deprecated. use pipeline based debit instead of methods directly in this class

This method will debit a StoreCredit for the amount that is passed into pAmount.

Parameters:

pOrder - the Order which contains the PaymentGroup

pPaymentGroup - the PaymentGroup against which we are debiting

pAmount - the amount to debit the PaymentGroup

Throws:

PaymentException - if an error occured while debiting or if the pPaymentGroup passed in is invalid.

CommerceException

creditCreditCard

protected PaymentStatus creditCreditCard(Order pOrder,
                                         CreditCard pPaymentGroup,
                                         double pAmount)
                                  throws CommerceException

Deprecated. use pipeline based credit instead of methods directly in this class

Credits a credit card a set amount. This method allows the user to specify whether a credit card can be credited against if it has not been debited by setting the @see #isDenyCreditWithNoDebit property.

Parameters:

pOrder - - the order that contains the PaymentGroup

pPaymentGroup - - the credit card payment group that should be credited

pAmount - - the amount that the payment group should be credited

Throws:

CommerceException

creditCreditCard

public CreditCardStatus creditCreditCard(CreditCardInfo pCreditCardInfo)

Deprecated. use pipeline based debit instead of methods directly in this class

Credits a credit card a set amount. This method runs independent of an Order.

Parameters:

pCreditCardInfo - - the information which is passed to the credit card processor

Returns:

a CreditCardStatus object containing the results of the transaction

creditGiftCertificate

protected PaymentStatus creditGiftCertificate(Order pOrder,
                                              GiftCertificate pPaymentGroup,
                                              double pAmount)
                                       throws CommerceException

Deprecated. use pipeline based credit instead of methods directly in this class

Credits a gift certificate a set amount.

Parameters:

pOrder - - the order that contains the PaymentGroup

pPaymentGroup - - the gift certificate payment group that should be credited

pAmount - - the amount that the payment group should be credited

Throws:

CommerceException

creditStoreCredit

protected PaymentStatus creditStoreCredit(Order pOrder,
                                          StoreCredit pPaymentGroup,
                                          double pAmount)
                                   throws CommerceException

Deprecated. use pipeline based credit instead of methods directly in this class

Credits a StoreCredit a set amount.

Parameters:

pOrder - - the order that contains the PaymentGroup

pPaymentGroup - - the StoreCredit payment group that should be credited

pAmount - - the amount that the payment group should be credited

Throws:

CommerceException

creditGiftCertificate

public GiftCertificateStatus creditGiftCertificate(GiftCertificateInfo pGiftCertificateInfo)

Deprecated. use pipeline based credit instead of methods directly in this class

Credits a gift certificate a set amount. This method runs independent of an Order.

Parameters:

pGiftCertificateInfo - - the information which is passed to the gift certificate processor

Returns:

a GiftCertificateStatus object containing the results of the transaction

creditStoreCredit

public StoreCreditStatus creditStoreCredit(StoreCreditInfo pStoreCreditInfo)

Deprecated. use pipeline based credit instead of methods directly in this class

Credits a store credit a set amount. This method runs independent of an Order.

Parameters:

pStoreCreditInfo - - the information which is passed to the StoreCredit processor

Returns:

a StoreCreditStatus object containing the results of the transaction

preProcessAuthorize

protected void preProcessAuthorize(Order pOrder,
                                   PaymentGroup pPaymentGroup,
                                   double pAmount)
                            throws CommerceException

This method executes pre processing before an authorize() call to a payment processor.

Parameters:

pOrder - the Order that the PaymentGroup exists in

pPaymentGroup - the PaymentGroup to be authorized

pAmount - the amount of the transaction

Throws:

CommerceException

postProcessAuthorize

protected void postProcessAuthorize(PaymentGroup pPaymentGroup,
                                    PaymentStatus pStatus,
                                    double pAmount)
                             throws CommerceException

This method executes post processing after an authorize() call to a payment processor.

Parameters:

pPaymentGroup - the PaymentGroup which was authorized

pStatus - the PaymentStatus object returned from the authorize call of the payment processor

pAmount - the amount of the transaction

Throws:

CommerceException

preProcessDebit

protected void preProcessDebit(Order pOrder,
                               PaymentGroup pPaymentGroup,
                               double pAmount)
                        throws CommerceException

This method executes pre processing before a debit() call to a payment processor.

Parameters:

pOrder - the Order that the PaymentGroup exists in

pPaymentGroup - the PaymentGroup to be debited

pAmount - the amount of the transaction

Throws:

CommerceException

postProcessDebit

protected void postProcessDebit(PaymentGroup pPaymentGroup,
                                PaymentStatus pStatus,
                                double pAmount)
                         throws CommerceException

This method executes post processing after a debit() call to a payment processor.

Parameters:

pPaymentGroup - the PaymentGroup which was debited

pStatus - the PaymentStatus object returned from the debit call of the payment processor

pAmount - the amount of the transaction

Throws:

CommerceException

preProcessCredit

protected void preProcessCredit(Order pOrder,
                                PaymentGroup pPaymentGroup,
                                double pAmount)
                         throws CommerceException

This method executes pre processing before a credit() call to a payment processor.

Parameters:

pOrder - the Order that the PaymentGroup exists in

pPaymentGroup - the PaymentGroup to be credited

pAmount - the amount of the transaction

Throws:

CommerceException

postProcessCredit

protected void postProcessCredit(PaymentGroup pPaymentGroup,
                                 PaymentStatus pStatus,
                                 double pAmount)
                          throws CommerceException

This method executes post processing after a credit() call to a payment processor.

Parameters:

pPaymentGroup - the PaymentGroup which was credited

pStatus - the PaymentStatus object returned from the credit call of the payment processor

pAmount - the amount of the transaction

Throws:

CommerceException

getLastAuthorizationStatus

public PaymentStatus getLastAuthorizationStatus(PaymentGroup pPaymentGroup)
                                         throws CommerceException

This method returns the last PaymentStatus object in the authorizationStatus list of the given PaymentGroup

Parameters:

pPaymentGroup - the PaymentGroup to get the PaymentStatus from

Throws:

CommerceException

getLastDebitStatus

public PaymentStatus getLastDebitStatus(PaymentGroup pPaymentGroup)
                                 throws CommerceException

This method returns the last PaymentStatus object in the debitStatus list of the given PaymentGroup

Parameters:

pPaymentGroup - the PaymentGroup to get the PaymentStatus from

Throws:

CommerceException

isAmountTooHigh

public boolean isAmountTooHigh(double pAmountSoFar,
                               double pNewAmount,
                               PaymentGroup pPaymentGroup)

This method will add pAmountSoFar and pNewAmount. If the sum is greater than pPaymentGroup.amount, then true is returned. Otherwise false is returned. This is used in preProcessAuthorize, preProcessDebit, preProcessCredit where pAmountSoFar is the amount that has previously been authorized, debited, or credited and pNewAmount is the amount that will soon be authorized, debited, or credited.

Parameters:

pAmountSoFar - The amount that has already been "processed"

pNewAmount - The amount that is going to be "processed" if this method returns false

pPaymentGroup - The payment group that will be modified

Returns:

true if pAmountSoFar + pNewAmount > pPaymentGroup.amount, false otherwise

isAmountTooHigh

public boolean isAmountTooHigh(double pAmountSoFar,
                               double pNewAmount,
                               PaymentGroup pPaymentGroup,
                               java.lang.String pCurrencyCode)

This method will add pAmountSoFar and pNewAmount. If the sum is greater than pPaymentGroup.amount, then true is returned. Otherwise false is returned. This is used in preProcessAuthorize, preProcessDebit, preProcessCredit where pAmountSoFar is the amount that has previously been authorized, debited, or credited and pNewAmount is the amount that will soon be authorized, debited, or credited.

Parameters:

pAmountSoFar - The amount that has already been "processed"

pNewAmount - The amount that is going to be "processed" if this method returns false

pPaymentGroup - The payment group that will be modified

pCurrencyCode - currency code which is used for rounding operation

Returns:

true if pAmountSoFar + pNewAmount > pPaymentGroup.amount, false otherwise

getChainName

protected java.lang.String getChainName(PaymentGroup pPaymentGroup)
                                 throws CommerceException

This method provides a mechanism by which to obtain a PipelineChain name from a given payment group. This is done by looking up a key in the paymentGroupToChainName map. They key is the class name of the payment group. The resulting value should be the corresponding chain.

Parameters:

pPaymentGroup - the payment group whose pipeline chain is obtained

Returns:

a chain name

Throws:

CommerceException - if pPaymentGroup is null, or no entry in the map could be found for the payment group class.

getAuthorizationChainName

protected java.lang.String getAuthorizationChainName(PaymentGroup pPaymentGroup)
                                              throws CommerceException

Obtain a pipeline chain that can authorize the pPaymentGroup. This implementation is done by calling the getChainName method.

Parameters:

pPaymentGroup - the payment group that the pipeline chain will be obtained for

Returns:

a pipeline chain name

Throws:

CommerceException - if an error occurs

getDebitChainName

protected java.lang.String getDebitChainName(PaymentGroup pPaymentGroup)
                                      throws CommerceException

Obtain a pipeline chain that can debit the pPaymentGroup. This implementation is done by calling the getChainName method.

Parameters:

pPaymentGroup - the payment group that the pipeline chain will be obtained for

Returns:

a pipeline chain name

Throws:

CommerceException - if an error occurs

getDecreaseAuthorizationChainName

protected java.lang.String getDecreaseAuthorizationChainName(PaymentGroup pPaymentGroup)
                                                      throws CommerceException

Obtain a pipeline chain that can decrease the authroization amount on the pPaymentGroup. This implementation is done by calling the getChainName method.

Parameters:

pPaymentGroup - the payment group that the pipeline chain will be obtained for

Returns:

a pipeline chain name

Throws:

CommerceException - if an error occurs

getCreditChainName

protected java.lang.String getCreditChainName(PaymentGroup pPaymentGroup)
                                       throws CommerceException

Obtain a pipeline chain that can credit the pPaymentGroup. This implementation is done by calling the getChainName method.

Parameters:

pPaymentGroup - the payment group that the pipeline chain will be obtained for

Returns:

a pipeline chain name

Throws:

CommerceException - if an error occurs

runProcessorChain

protected PipelineResult runProcessorChain(java.lang.String pChainName,
                                           PaymentManagerPipelineArgs pParameters)
                                    throws CommerceException

Utility method to run a pipeline chain.

Parameters:

pChainName - the name of the chain to run

pParameters - the parameters to hand to the chain

Throws:

CommerceException - if an error occurs

retrieveAllSupportedPaymentTypes

public java.util.List<PaymentType> retrieveAllSupportedPaymentTypes()
                                                             throws CommerceException

Retrieves a list of all supported payment types in the system.

Returns:

A list of all supported payment types in the system.

Throws:

A - CommerceExcpetion if an error occurred.

CommerceException

getPaymentTypes

public java.util.Set<PaymentType> getPaymentTypes(java.util.Set<java.lang.String> pPaymentTypeStrings)
                                           throws CommerceException

Get payment type objects from a set of payment type strings.

Parameters:

pPaymentTypeStrings - The set of strings to create payment type objects from.

Returns:

A non-null set of payment type objects generated using the strings passed in. If an empty set was passed in, an empty set will be returned.

Throws:

CommerceException - if a payment type string could not be parsed or an unsupported payment group type was found.

getPaymentTypes

public java.util.Set<PaymentType> getPaymentTypes(Order pOrder)
                                           throws CommerceException

Get a set of payment type objects associated with an order. The payment types returned will be based upon the order's payment groups. Unless otherwise stated (by setting the payment manager property 'includePaymentGroupsWithoutOrderRelationship' to true) then only payment groups which have a payment group relationship with the order will be included.

Parameters:

pOrder - The order whose payment groups we are interested in getting payment types for.

Returns:

A set of payment type objects associated with the order's payment group(s) by way of a PaymentGroupOrderRelationship. If there are no payment groups, or they have no such relationships, an empty set is returned.

Throws:

CommerceException - if the payment group identifier couldn't be matched to a known payment group type.

getSupportedPaymentTypes

public java.util.Set<PaymentType> getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier)
                                                    throws InvalidParameterException

Specified by:

getSupportedPaymentTypes in interface PaymentTypeProvider

Parameters:

pPaymentGroupIdentifier - An identifier for the group we're going to get payment types for.

Returns:

A set of payment types corresponding to the payment group identifier passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getGroupPaymentType

protected PaymentType getGroupPaymentType(java.lang.String pPaymentGroupIdentifier)
                                   throws InvalidParameterException

Selects an already generated payment type object corresponding to the payment group identifier passed in.

Parameters:

pPaymentGroupIdentifier - The payment group identifier we're interested in.

Returns:

a payment type object if one was found for the identifier passed in.

Throws:

InvalidParameterException - if the payment group identifier had no corresponding payment type object.

getPaymentTypeForPaymentGroup

public PaymentType getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup)
                                          throws InvalidParameterException

Get a payment type object for a specific payment group which has a payment amount greater than zero.

Specified by:

getPaymentTypeForPaymentGroup in interface PaymentTypeProvider

Parameters:

pPaymentGroup - The payment group whose payment type we're interested in.

Returns:

A single payment type object representing the payment group passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getPaymentTypeForString

public PaymentType getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier,
                                           java.lang.String pRemainderOfPaymentTypeString)
                                    throws InvalidParameterException

Create a payment type object based upon a formatted string.

Specified by:

getPaymentTypeForString in interface PaymentTypeProvider

Parameters:

pPaymentGroupIdentifier - An identifier for the payment group which the payment type will related to.

pRemainderOfPaymentTypeString - The original payment string will have consisted of the group identifier followed by other info specific to that payment type. So this is the rest of the string minus the group identifier (and first delimiter). It will be up to individual providers what to do with this information, but one expected use will be that it denotes a variation of a payment group type.

Returns:

A payment type object representing the strings passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

createSupportedPaymentTypesMap

protected java.util.Map<java.lang.String,PaymentType> createSupportedPaymentTypesMap()

Generate the supported payment types in map form, keyed by payment group identifier. Note: Payment Manager is only used to manage payment types for payment groups which have no variations (e.g. not something like Credit Card where there are many different variations of credit card).

doStartService

public void doStartService()
                    throws ServiceException

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up