com.ibm.etill.framework.admin
Class Admin

java.lang.Object
  |
  +--com.ibm.etill.framework.admin.Admin

public final class Admin
extends Object

Admin provides various administrative services to cassettes through a set of class methods. Since this class only contains static methods and no instance variables, it is never actually instantiated.


Constructor Summary
Admin()
           
 
Method Summary
static AccountAdmin getAccountAdminObject(String cassetteName, String merchantNumber, String accountNumber)
          Retrieves the generic account object for the specified cassette/merchant/account.
static Enumeration getAccountAdminObjects(String cassetteName)
          Retrieves all the generic account objects for the specified cassette.
static Enumeration getAccountAdminObjects(String cassetteName, String merchantNumber)
          Retrieves all the generic account objects for the specified cassette/merchant.
static CassetteAdmin getCassetteAdminObject(String cassetteName)
          Retrieves the generic cassette object for the specified cassette.
static MerchantAdmin getMerchantAdminObject(String merchantNumber)
          Retrieves the generic merchant object for the specified merchant.
static PayServer getPayServerObject()
          Retrieves the generic Commerce Payments Framework object for this Commerce Payments instance.
static PaySystemAdmin getPaySystemAdminObject(String cassetteName, String merchantNumber)
          Retrieves the generic object that represents the merchant/cassette relationship (sometimes called the PaymentSystem).
static UserAdmin getUserAdminObject(String userName)
          Retrieves the generic user object for the specified Commerce Payments user.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Admin

public Admin()
Method Detail

getAccountAdminObject

public static AccountAdmin getAccountAdminObject(String cassetteName,
                                                 String merchantNumber,
                                                 String accountNumber)
Retrieves the generic account object for the specified cassette/merchant/account.
Parameters:
cassetteName - a String containing the name of the cassette (as it appears in the ETCASSETTECFG table) of the cassette with which the requested account is associated.
merchantNumber - a String containing the unique merchant number of the merchant that owns the requested object.
accountNumber - a String containing the requested account number
Returns:
AccountAdmin - the generic account object representing the specified account; null if the object is not found.

getAccountAdminObjects

public static Enumeration getAccountAdminObjects(String cassetteName)
Retrieves all the generic account objects for the specified cassette.
Parameters:
cassetteName - a String containing the name of the cassette (as it appears in the ETCASSETTECFG table) of the cassette with which the requested account is associated.
Returns:
Enumeration - an enumeration of generic account objects (AccountAdmin)

getAccountAdminObjects

public static Enumeration getAccountAdminObjects(String cassetteName,
                                                 String merchantNumber)
Retrieves all the generic account objects for the specified cassette/merchant.
Parameters:
cassetteName - a String containing the name of the cassette (as it appears in the ETCASSETTECFG table) of the cassette with which the requested account is associated.
merchantNumber - a String containing the unique merchant number of the merchant that owns the requested object.
Returns:
Enumeration an enumeration of generic account objects (AccountAdmin)

getCassetteAdminObject

public static CassetteAdmin getCassetteAdminObject(String cassetteName)
Retrieves the generic cassette object for the specified cassette.
Parameters:
cassetteName - a String containing the name of the cassette (as it appears in the ETCASSETTECFG table) of the cassette.
Returns:
CassetteAdmin - the generic cassette object representing the specified cassette; null if the object is not found.

getMerchantAdminObject

public static MerchantAdmin getMerchantAdminObject(String merchantNumber)
Retrieves the generic merchant object for the specified merchant.
Parameters:
merchantNumber - a String containing the unique merchant number of the merchant.
Returns:
MerchantAdmin - the generic merchant object representing the specified merchant; null if the object is not found.

getPayServerObject

public static PayServer getPayServerObject()
Retrieves the generic Commerce Payments Framework object for this Commerce Payments instance.
Returns:
PayServer - the Commerce Payments object.

getPaySystemAdminObject

public static PaySystemAdmin getPaySystemAdminObject(String cassetteName,
                                                     String merchantNumber)
Retrieves the generic object that represents the merchant/cassette relationship (sometimes called the PaymentSystem).
Parameters:
cassetteName - a String containing the name of the cassette (as it appears in the ETCASSETTECFG table) of the cassette.
merchantNumber - a String containing the unique merchant number of the merchant.
Returns:
PaySystemAdmin - the generic object representing the specified relationship; null if the object is not found.

getUserAdminObject

public static UserAdmin getUserAdminObject(String userName)
                                    throws ETillAbortOperation
Retrieves the generic user object for the specified Commerce Payments user.
Parameters:
userName - a String containing a valid Commerce Payments user name.
Returns:
UserAdmin - the generic user object representing the specified user; null if the object is not found.
Throws:
ETillAbortOperation - thrown if a database access error occurs.