com.konakart.blif

Interface PaymentMgrIf

All Known Implementing Classes:

PaymentMgr

public interface PaymentMgrIf

PaymentMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
PaymentDetails	getPaymentDetails(java.lang.String sessionId, java.lang.String moduleCode, int orderId, java.lang.String hostAndPort, int languageId) This method is called once a payment gateway has been selected and an order has been saved in the database.
PaymentDetails	getPaymentDetailsCustom(java.lang.String sessionId, java.lang.String moduleCode, NameValueIf[] parameters) Method used to return any custom information required from the payment module.
PaymentDetails	getPaymentDetailsPerOrder(java.lang.String sessionId, java.lang.String moduleCode, OrderIf order, java.lang.String hostAndPort, int languageId) This method is called once a payment gateway has been selected even if the order has not been saved in the database.
PaymentDetails	getPaymentGateway(OrderIf order, java.lang.String moduleName, int languageId) Return the PaymentDetail object for one payment gateway.
PaymentDetails[]	getPaymentGateways(OrderIf order, int languageId) Each payment module is called and asked to return a PaymentDetails object.
void	refreshConfigs() Refreshes the configuration data for this manager

Method Detail

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refreshes the configuration data for this manager

Throws:

java.lang.Exception - an unexpected exception

getPaymentGateways

PaymentDetails[] getPaymentGateways(OrderIf order,
                                    int languageId)
                             throws java.lang.Exception

Each payment module is called and asked to return a PaymentDetails object. This method is called during the checkout process before the order has been saved and confirmed by the user. Therefore it does not compile the exact details for the payment (i.e. the parameters passed to a payment gateway) since this will be done later for the selected payment module. The returned PaymentDetails object contains the information required for the user to select it and based on the zone of the billing address the module may decide that it cannot process payment for that zone and so not even return a PaymentDetails object.

Parameters:

order - the order

languageId - the languageId

Returns:

Returns an array of PaymentDetail objects

Throws:

java.lang.Exception - an unexpected exception

getPaymentGateway

PaymentDetails getPaymentGateway(OrderIf order,
                                 java.lang.String moduleName,
                                 int languageId)
                          throws java.lang.Exception

Return the PaymentDetail object for one payment gateway.

Parameters:

order - the order

moduleName - can be module name on its own or it can be "moduleName~~moduleSubCode" if the module has a subCode

languageId - the languageId

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetails

PaymentDetails getPaymentDetails(java.lang.String sessionId,
                                 java.lang.String moduleCode,
                                 int orderId,
                                 java.lang.String hostAndPort,
                                 int languageId)
                          throws java.lang.Exception

This method is called once a payment gateway has been selected and an order has been saved in the database. The order is read from the database and the details of the payment are retrieved from the order. This ensures that the payment request matches the order exactly. The module matching the module code is called in order to get a fully populated PaymentDetails object containing all of the required parameters etc. for the payment gateway.

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

orderId - the orderId

hostAndPort - the hostAndPort

languageId - the languageId

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetailsPerOrder

PaymentDetails getPaymentDetailsPerOrder(java.lang.String sessionId,
                                         java.lang.String moduleCode,
                                         OrderIf order,
                                         java.lang.String hostAndPort,
                                         int languageId)
                                  throws java.lang.Exception

This method is called once a payment gateway has been selected even if the order has not been saved in the database. The details of the payment are retrieved from the order. The module matching the module code is called in order to get a fully populated PaymentDetails object containing all of the required parameters etc. for the payment gateway.

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

order - the order

hostAndPort - the hostAndPort

languageId - the languageId

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetailsCustom

PaymentDetails getPaymentDetailsCustom(java.lang.String sessionId,
                                       java.lang.String moduleCode,
                                       NameValueIf[] parameters)
                                throws java.lang.Exception

Method used to return any custom information required from the payment module.

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

parameters - the parameters

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception