com.ibm.etill.framework.admin
Class AccountAdmin

java.lang.Object
  |
  +--com.ibm.etill.framework.admin.AdminObject
        |
        +--com.ibm.etill.framework.admin.AccountAdmin
All Implemented Interfaces:
Archivable, PSServerAdminConstants
Direct Known Subclasses:
FrameworkAccountAdmin

public abstract class AccountAdmin
extends AdminObject

AccountAdmin objects describe the Framework properties of accounts within the Payment Engine. Cassettes can augment AccountAdmin objects with their own properties in their own cassette-specific objects as well as through the creation of MerchantCassetteObjects related to the account.

Cassettes should NOT extend this class. Instead, augmenting properties are supported when administration commands for a specific AccountAdmin object are forwarded to the Cassette object's service method for processing. At that time, the cassette decides how to handle the request including which of its internal objects to update.

MerchantCassetteObjects are primary administration objects defined by the cassette. These classes extend com.ibm.etill.framework.admin.AdminObject and are associated with the AccountAdmin object according to cassette-supplied rules.

The external view of AccountAdmin objects is provided through the com.ibm.etill.framework.xdm.PSServerAdminObject class

See Also:
AdminObject, PSServerAccount, PSServerAdminObject

Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Method Summary
 Hashtable batchesForAccount()
          Returns a Hashtable of all the open batches that exist for this account.
 short getAcceptPaymentAutoApprove()
          accessor for acceptPaymentAutoApprove flag
 boolean getAcceptPaymentAutoDeposit()
          accessor for acceptPaymentAutoDeposit flag
 String getAccountNumber()
          Returns the account number of this account object.
 String getAccountTitle()
          Returns the text title for this account.
 int getApprovalExpiration()
          accessor for approvalExpiration value @38247
 String getCassetteName()
          Returns the name of the cassette with which this account is associated.
 String getFinancialInstitutionTitle()
          Returns the text title for the financial institution with which this account is associated.
 String getMerchantNumber()
          Returns the merchant number of the merchant with which this account is associated.
 ReaderWriterMonitor getReaderWriterMonitor()
          Cassettes should never call this method.
 short getReceivePaymentAutoApprove()
          accessor for receivePaymentAutoApprove flag
 boolean getReceivePaymentAutoDeposit()
          accessor for receivePaymentAutoDeposit flag
 boolean getSupportAcceptPayment()
          accessor for acceptPayment supported
 boolean getSupportApprovalExpiration()
          accessor for approvalExpiry supported @38247
 boolean getSupportReceivePayment()
          accessor for receivePayment supported
static boolean isApprovalExpiryInMins()
          Returns where the approval expiration delay is in minutes or not
 void setAcceptPaymentAutoApprove(short parm)
          modifier for acceptPaymentAutoApprove flag
 void setAcceptPaymentAutoDeposit(boolean parm)
          modifier for acceptPaymentAutoDeposit flag
 void setApprovalExpiration(int parm)
          modifier for approvalExpiration flag @38247
static void setApprovalExpiryInMins(boolean inMins)
          sets that approval expiration value is in minutes (rather than days) this is for testing purposes
 void setReceivePaymentAutoApprove(short parm)
          modifier for receivePaymentAutoApprove flag
 void setReceivePaymentAutoDeposit(boolean parm)
          modifier for receivePaymentAutoDeposit flag
 void setSupportAcceptPayment(boolean parm)
          modifier for acceptPayment supported
 void setSupportApprovalExpiration(boolean parm)
          modifier for approvalExpiry supported @38247
 void setSupportReceivePayment(boolean parm)
          modifier for receivePayment supported
 String toString()
          Returns a string representation of this account object for tracing purposes.
 
Methods inherited from class com.ibm.etill.framework.admin.AdminObject
addCassetteMessage, addFrameworkMessage, getActive, getEnabled, getInvalidList, getPending, processConfigurationChanges, processExtension, setActive, setEnabled, setEnabled, setPending, startObject, stopObject, validateExtension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etill.framework.archive.Archivable
createRecord, deleteRecord, updateRecord
 

Method Detail

getCassetteName

public String getCassetteName()
Returns the name of the cassette with which this account is associated.
Returns:
String - the cassette name as it appears in the ETCASSETTECFG table

getMerchantNumber

public String getMerchantNumber()
Returns the merchant number of the merchant with which this account is associated.
Returns:
String - the merchant number

getAccountNumber

public String getAccountNumber()
Returns the account number of this account object.
Returns:
String - the account number

getAccountTitle

public String getAccountTitle()
Returns the text title for this account. This title appears on the Commerce Payments User Interface screens.
Returns:
String - the account title

getFinancialInstitutionTitle

public String getFinancialInstitutionTitle()
Returns the text title for the financial institution with which this account is associated. This title appears on the Commerce Payments User Interface screens.
Returns:
String - the financial institution title

getAcceptPaymentAutoApprove

public short getAcceptPaymentAutoApprove()
accessor for acceptPaymentAutoApprove flag
Returns:
short

setAcceptPaymentAutoApprove

public void setAcceptPaymentAutoApprove(short parm)
modifier for acceptPaymentAutoApprove flag

getAcceptPaymentAutoDeposit

public boolean getAcceptPaymentAutoDeposit()
accessor for acceptPaymentAutoDeposit flag
Returns:
boolean

setAcceptPaymentAutoDeposit

public void setAcceptPaymentAutoDeposit(boolean parm)
modifier for acceptPaymentAutoDeposit flag

getReceivePaymentAutoApprove

public short getReceivePaymentAutoApprove()
accessor for receivePaymentAutoApprove flag
Returns:
short

setReceivePaymentAutoApprove

public void setReceivePaymentAutoApprove(short parm)
modifier for receivePaymentAutoApprove flag

getReceivePaymentAutoDeposit

public boolean getReceivePaymentAutoDeposit()
accessor for receivePaymentAutoDeposit flag
Returns:
boolean

setReceivePaymentAutoDeposit

public void setReceivePaymentAutoDeposit(boolean parm)
modifier for receivePaymentAutoDeposit flag

getSupportAcceptPayment

public boolean getSupportAcceptPayment()
accessor for acceptPayment supported
Returns:
boolean

setSupportAcceptPayment

public void setSupportAcceptPayment(boolean parm)
modifier for acceptPayment supported

getSupportReceivePayment

public boolean getSupportReceivePayment()
accessor for receivePayment supported
Returns:
boolean

setSupportReceivePayment

public void setSupportReceivePayment(boolean parm)
modifier for receivePayment supported

batchesForAccount

public Hashtable batchesForAccount()
Returns a Hashtable of all the open batches that exist for this account.
Returns:
Hashtable - contains each of the open batch for this account. batchNumber is used as the key, with the referenced object being the Batch object.

getReaderWriterMonitor

public ReaderWriterMonitor getReaderWriterMonitor()
Cassettes should never call this method.

toString

public String toString()
Returns a string representation of this account object for tracing purposes.
Overrides:
toString in class AdminObject
Returns:
String - a string representation of the key elements of this account object.

getApprovalExpiration

public int getApprovalExpiration()
accessor for approvalExpiration value @38247
Returns:
int

getSupportApprovalExpiration

public boolean getSupportApprovalExpiration()
accessor for approvalExpiry supported @38247
Returns:
boolean

setApprovalExpiration

public void setApprovalExpiration(int parm)
modifier for approvalExpiration flag @38247

setSupportApprovalExpiration

public void setSupportApprovalExpiration(boolean parm)
modifier for approvalExpiry supported @38247

isApprovalExpiryInMins

public static boolean isApprovalExpiryInMins()
Returns where the approval expiration delay is in minutes or not

setApprovalExpiryInMins

public static void setApprovalExpiryInMins(boolean inMins)
sets that approval expiration value is in minutes (rather than days) this is for testing purposes
Parameters:
inMins - true indicates that the approval expiration delay is in minutes