com.ibm.etill.cashier
Interface CashierExtension

All Known Implementing Classes:
BankServACHCashierExtension, GenericExtension

public interface CashierExtension

A class that implements this interface will be called to generate a value for any extension parameter in a profile which reference the class.


Method Summary
java.lang.String getValue(java.lang.String keyword, java.util.Hashtable environmentValues, java.util.Hashtable paymentManagerParameters, java.sql.Connection connection, CashierTrace cashierTrace, java.util.Locale locale) This method is called by the cashier to give the CashierExtension an opportunity to construct and return a value for the referenced keyword.

Method Detail

getValue

public java.lang.String getValue(java.lang.String keyword,
                                 java.util.Hashtable environmentValues,
                                 java.util.Hashtable paymentManagerParameters,
                                 java.sql.Connection connection,
                                 CashierTrace cashierTrace,
                                 java.util.Locale locale)
                          throws CashierException
This method is called by the cashier to give the CashierExtension an opportunity to construct and return a value for the referenced keyword.
Parameters:
keyword - name of the Commerce Payments keyword for which the value is needed.
environmentValues - values from the order processing environment.
paymentManagerParameters - hashtable of Commerce Payments keyword-values which have already been mapped by the cashier.
connection - Connection to be used to look up database values. (close it yourself after this call)
cashierTrace - CashierTrace class which an extension may use to write into the Cashier trace facility.
locale - locale passed to the cashier on the collectPayment() call.
Throws:
CashierException - if there is an error using the cashier.

Feedback