com.ibm.etill.framework.xdm
Class PSServerAccount

java.lang.Object
  |
  +--com.ibm.etill.framework.xdm.PSServerObject
        |
        +--com.ibm.etill.framework.xdm.PSServerAdminObject
              |
              +--com.ibm.etill.framework.xdm.PSServerAccount
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, PSServerAccountConstants, PSServerAdminConstants, com.ibm.etill.framework.clientapi.XDMConstants

public final class PSServerAccount
extends PSServerAdminObject
implements PSServerAccountConstants

This is the server-side account class.

It keeps track of the account number and other relevant account properties. And provides operators for accessing these properties.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAccountConstants
AccountAdminTable, APPROXIMATE_XDM_OBJECT_SIZE, COL_ACCOUNTNUMBER, COL_ACCOUNTTITLE, COL_APPROVALEXPIRY, COL_CASSETTENAME, COL_FITITLE, COL_GROWTH1, COL_MERCHANTNUMBER
 
Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Fields inherited from interface com.ibm.etill.framework.clientapi.XDMConstants
batchStates, batchStatusList, creditStates, orderStates, paymentStates, PAYSERVERDTD, XDAN_ACCOUNTNAME, XDAN_ACCOUNTNUMBER, XDAN_ACTIVE, XDAN_ADMINHOSTNAME, XDAN_AMOUNT, XDAN_AMOUNTEXP10, XDAN_APAUTOAPPROVE, XDAN_APAUTODEPOSIT, XDAN_APPROVALEXPIRATION, XDAN_APPROVALEXPIRY, XDAN_APPROVEAMOUNT, XDAN_APPROVESALLOWED, XDAN_APPROVETIME, XDAN_BATCHNUMBER, XDAN_BATCHSTATUS, XDAN_BRAND, XDAN_BUYER_MESSAGE, XDAN_CASSETTEMSGS, XDAN_CASSETTENAME, XDAN_CHANGESPENDING, XDAN_COMMTYPE, XDAN_COMPANYPKGNAME, XDAN_CONFIGURATIONFLAG, XDAN_CONTENT, XDAN_CONTENTTYPE, XDAN_CREDITNUMBER, XDAN_CURRENCY, XDAN_DEPOSITAMOUNT, XDAN_DISPLAYDESCRIPTION, XDAN_DISPLAYHELP, XDAN_DISPLAYLENGTH, XDAN_DISPLAYMODE, XDAN_DISPLAYNAME, XDAN_DISPLAYTYPE, XDAN_ENABLED, XDAN_ETILLHOSTNAME, XDAN_EVENTTYPE, XDAN_FITITLE, XDAN_FORCEALLOWED, XDAN_FRAMEWORKMSGS, XDAN_ID, XDAN_KEY, XDAN_LISTENERURL, XDAN_MERCHANT_MESSAGE, XDAN_MERCHANTCONTROL, XDAN_MERCHANTNUMBER, XDAN_MERCHANTORIGINATED, XDAN_MERCHANTTITLE, XDAN_NDHOSTNAME, XDAN_NUMBEROFADMINCOMMANDS, XDAN_NUMBEROFCREDITS, XDAN_NUMBEROFORDERCOMMANDS, XDAN_NUMBEROFPAYMENTCOMMANDS, XDAN_NUMBEROFPAYMENTS, XDAN_NUMBEROFQUERYCOMMANDS, XDAN_OBJECT_COUNT, XDAN_OBJECTID, XDAN_ORDER, XDAN_ORDERDATA1, XDAN_ORDERDATA2, XDAN_ORDERDATA3, XDAN_ORDERDATA4, XDAN_ORDERDATA5, XDAN_ORDERNUMBER, XDAN_ORDERURL, XDAN_PAYMENTGROUPNAME, XDAN_PAYMENTNUMBER, XDAN_PAYMENTTYPE, XDAN_PLEXNAME, XDAN_PRIMARY_RC, XDAN_PROPERTYID, XDAN_PURGEALLOWED, XDAN_REALM, XDAN_REFERENCENUMBER, XDAN_REQUIRED, XDAN_ROLES, XDAN_RPAUTOAPPROVE, XDAN_RPAUTODEPOSIT, XDAN_SECONDARY_RC, XDAN_SIZE, XDAN_SOCKSHOST, XDAN_SOCKSPORT, XDAN_STATE, XDAN_SYSPLEXFLAG, XDAN_TIMEREGISTERED, XDAN_TIMESTAMPCLOSED, XDAN_TIMESTAMPCREATED, XDAN_TIMESTAMPMODIFIED, XDAN_TIMESTAMPOPENED, XDAN_TOTALCREDITAMOUNT, XDAN_TOTALMATCHES, XDAN_TOTALPAYMENTAMOUNT, XDAN_TRANSACTIONID, XDAN_TRANSFORM, XDAN_UNAPPROVEDAMOUNT, XDAN_USERNAME, XDAN_VALID, XDAN_VALUE, XDAN_VERSION, XDAN_WITHCREDITS, XDAN_WITHORDERS, XDAN_WITHPAYMENTS, XDAV_ADVANCED, XDAV_BASIC, XDAV_BATCH_PREFIX, XDAV_BOTH, XDAV_CASSETTE_OBJECT, XDAV_CREDIT_PREFIX, XDAV_FALSE, XDAV_HIDDEN, XDAV_ID_SEPARATOR, XDAV_ORDER_DESCRIPTION, XDAV_ORDER_PREFIX, XDAV_PAYMENT_PREFIX, XDAV_READONLY, XDAV_READWRITE, XDAV_TRANSFORM_NONE, XDAV_TRANSFORM_URL, XDAV_TRUE, XDAV_UNRECOGNIZED_STATE, XDAV_UNRECOGNIZED_STATUS, XDAV_UNSUPPORTED_ENCODING, XDCT_RESULTS_HEADER, XDDV_XML_ENCODING, XDDV_XML_VERSION, XDEN_ACCOUNTCOLLECTION, XDEN_BATCHCOLLECTION, XDEN_BATCHKEY, XDEN_BATCHLIST, XDEN_BATCHTOTALCOLLECTION, XDEN_CASSETTECOLLECTION, XDEN_CASSETTECONFIGOBJECT, XDEN_CASSETTEEXTOBJECT, XDEN_CASSETTEOBJECT, XDEN_CASSETTEPROPERTY, XDEN_CREDITCOLLECTION, XDEN_CREDITKEY, XDEN_CREDITLIST, XDEN_EVENTLISTENERCOLLECTION, XDEN_MERCHANTCOLLECTION, XDEN_MERCHCASSCOLLECTION, XDEN_ORDERCOLLECTION, XDEN_ORDERKEY, XDEN_ORDERLIST, XDEN_PACKAGEDCONTENT, XDEN_PAYMENTCOLLECTION, XDEN_PAYMENTKEY, XDEN_PAYMENTLIST, XDEN_PSABOUT, XDEN_PSACCOUNT, XDEN_PSBATCH, XDEN_PSBATCHTOTAL, XDEN_PSCASSETTE, XDEN_PSCASSETTEABOUT, XDEN_PSCREDIT, XDEN_PSEVENTLISTENER, XDEN_PSMERCHANT, XDEN_PSMERCHCASS, XDEN_PSOPERATION, XDEN_PSORDER, XDEN_PSPAYMENT, XDEN_PSPAYMENTSERVER, XDEN_PSSYSPLEX, XDEN_PSUSERINFO, XDEN_ROOT_ELEMENT, XDEN_USERINFOCOLLECTION
 
Constructor Summary
PSServerAccount()
          The default constructor does nothing.
 
Method Summary
 short getAcceptPaymentAutoApprove()
          accessor for acceptPaymentAutoApprove flag
 boolean getAcceptPaymentAutoDeposit()
          accessor for acceptPaymentAutoDeposit flag
 String getAccountNumber()
          Gets the account number for this account
 String getAccountTitle()
          Gets the account title for this account
 int getApprovalExpiration()
          accessor for approvalExpiration value @38247
 String getCassetteName()
          Gets cassette name
 String getFinancialInstitutionTitle()
          Gets the financial institution title for this account.
 String getMerchantNumber()
          Gets the merchant number for this account
 String getPaymentType()
          Gets the payment type for this account
 short getReceivePaymentAutoApprove()
          accessor for receivePaymentAutoApprove flag
 boolean getReceivePaymentAutoDeposit()
          accessor for receivePaymentAutoDeposit flag
 boolean getSupportAcceptPayment()
          accessor for supportAcceptPayment flag
 boolean getSupportApprovalExpiration()
          accessor for supportApprovalExpiration flag
 boolean getSupportReceivePayment()
          accessor for supportReceivePayment flag
static Vector query(AccountQueryRequest request, ResultSet rs)
          Queries Payment Server for account.
static Vector retrieveAllRecords()
          Gets all account records.
 void setAcceptPaymentAutoApprove(short parm)
          modifier for acceptPaymentAutoApprove flag
 void setAcceptPaymentAutoDeposit(boolean parm)
          modifier for acceptPaymentAutoDeposit flag
 void setApprovalExpiration(int parm)
          modifier for approvalExpiration value @38247
 void setReceivePaymentAutoApprove(short parm)
          modifier for receivePaymentAutoApprove flag
 void setReceivePaymentAutoDeposit(boolean parm)
          modifier for receivePaymentAutoDeposit flag
 com.ibm.etill.framework.xdm.TXElement toXml()
          Converts account elements and attributes to an XML document.
static com.ibm.etill.framework.xdm.TXElement toXMLAccountCollection(Enumeration accounts)
          Converts account into their corresponding XML documents.
 
Methods inherited from class com.ibm.etill.framework.xdm.PSServerAdminObject
addCassetteConfigObject, getApproximateXDMSize, getMessages, isActive, isEnabled, isPending, isValid, setCassetteExtensionObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSServerAccount

public PSServerAccount()
The default constructor does nothing.
Method Detail

getCassetteName

public String getCassetteName()
Gets cassette name
Returns:
String The cassette name.

getMerchantNumber

public String getMerchantNumber()
Gets the merchant number for this account
Returns:
String The merchant number for this account.

getAccountNumber

public String getAccountNumber()
Gets the account number for this account
Returns:
String The account number for this account.

getAccountTitle

public String getAccountTitle()
Gets the account title for this account
Returns:
String The account title for this account.

getFinancialInstitutionTitle

public String getFinancialInstitutionTitle()
Gets the financial institution title for this account.
Returns:
String The financial institution title for this account.

getPaymentType

public String getPaymentType()
Gets the payment type for this account
Returns:
String The cassette name for this account.

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

getSupportReceivePayment

public boolean getSupportReceivePayment()
accessor for supportReceivePayment flag
Returns:
short

getSupportAcceptPayment

public boolean getSupportAcceptPayment()
accessor for supportAcceptPayment flag
Returns:
short

query

public static Vector query(AccountQueryRequest request,
                           ResultSet rs)
                    throws ETillAbortOperation
Queries Payment Server for account.
Parameters:
request - A AccountQueryRequest object.
rs - A result set object.
Returns:
result A vector containing query output.
Throws:
ETillAbortOperation - if a database error is enountered.

toXml

public com.ibm.etill.framework.xdm.TXElement toXml()
Converts account elements and attributes to an XML document.
Returns:
xml The XML document. Change History: 38247 03/09/01 wsa Added Approval Expiration

toXMLAccountCollection

public static com.ibm.etill.framework.xdm.TXElement toXMLAccountCollection(Enumeration accounts)
Converts account into their corresponding XML documents.
Parameters:
accounts - An enumeration of PSServerAccount
Returns:
collection A set of documents.

retrieveAllRecords

public static Vector retrieveAllRecords()
                                 throws ETillAbortOperation
Gets all account records.
Returns:
Vector A list of all accounts records.
Throws:
ETillAbortOperation - thrown if a catastrophic error is encountered

getApprovalExpiration

public int getApprovalExpiration()
accessor for approvalExpiration value @38247

getSupportApprovalExpiration

public boolean getSupportApprovalExpiration()
accessor for supportApprovalExpiration flag
Returns:
boolean whether approval expiration is supported

setApprovalExpiration

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