com.ibm.etill.framework.xdm
Class PSServerPayment

java.lang.Object
  |
  +--com.ibm.etill.framework.xdm.PSServerObject
        |
        +--com.ibm.etill.framework.xdm.PSServerFinancialObject
              |
              +--com.ibm.etill.framework.xdm.PSServerPayment
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, PSServerPaymentConstants, com.ibm.etill.framework.clientapi.XDMConstants

public final class PSServerPayment
extends PSServerFinancialObject
implements PSServerPaymentConstants

This is a subclass of PSServerFinancialObject and implements the PSServerPaymentConstants interface.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerPaymentConstants
APPROXIMATE_XDM_KEY_SIZE, APPROXIMATE_XDM_OBJECT_SIZE, COL_ACCOUNTNUMBER, COL_ACQUIRERID, COL_AMOUNTEXP10, COL_AMOUNTVALUE, COL_APPROVALEXPIRY, COL_APPROVESALLOWED, COL_APPROVETIME, COL_BATCHNUMBER, COL_BRANDID, COL_CURRENCY, COL_CURRENTSTATE, COL_DEPOSITAMOUNT, COL_GROWTH3, COL_MERCHANTNAME, COL_ORDERAMOUNT, COL_ORDERNUMBER, COL_ORDERSTATE, COL_ORDERTIMECREATED, COL_ORDERTIMEMODIFIED, COL_PAYMENTNUMBER, COL_PAYMENTTYPE, COL_TIMESTAMPCREATED, COL_TIMESTAMPMODIFIED, COL_UNAPPROVEDAMOUNT, PAYMENT, PAYMENTVIEW, VIEW_ACCOUNTNUMBER, VIEW_ACQUIRERID, VIEW_AMOUNTEXP10, VIEW_APPROVALEXPIRY, VIEW_APPROVESALLOWED, VIEW_APPROVETIME, VIEW_BATCHNUMBER, VIEW_CARDHOLDERID, VIEW_CURRENCY, VIEW_DEPOSITAMOUNT, VIEW_GROWTH3, VIEW_MERCHANTNAME, VIEW_ORDERAMOUNT, VIEW_ORDERNUMBER, VIEW_ORDERSTATE, VIEW_ORDERTIMECREATED, VIEW_ORDERTIMEMODIFIED, VIEW_PAYMENTAMOUNT, VIEW_PAYMENTNUMBER, VIEW_PAYMENTSTATE, VIEW_PAYMENTTIMECREATED, VIEW_PAYMENTTIMEMODIFIED, VIEW_PAYMENTTYPE, VIEW_UNAPPROVEDAMOUNT
 
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
PSServerPayment()
          The default constructor.
 
Method Summary
 String getAccountNumber()
          Gets the Account Number
 Timestamp getApprovalExpiry()
          Gets the time payment approval is to expire @38247
 Timestamp getApproveTime()
          Gets the time payment was approved @38247
 String getBatchNumber()
          Gets the Batch Number
 String getMerchantNumber()
          Gets the Merchant Number
 String getOrderNumber()
          Gets the Order Number
 String getPaymentNumber()
          Gets the Credit Number
 String getPaymentType()
          Gets the Payment Type
 Timestamp getTimeCreated()
          Gets the time order was created
static Vector query(PaymentQueryRequest request, ResultSet rs)
          Queries database for this Payment request
 com.ibm.etill.xml.parser.TXElement toXml(boolean withOrders)
          Converts PSServerPayment object to an XML element
 com.ibm.etill.xml.parser.TXElement toXmlKeysOnly()
          Converts only the required fields of this PSServerPayment object to an XML element.
static com.ibm.etill.xml.parser.TXElement toXMLPaymentCollection(Enumeration payments, boolean withOrders, Enumeration orders)
          Converts Payment Server credit collection to an XML element.
static com.ibm.etill.xml.parser.TXElement toXMLPaymentKeyCollection(Enumeration payments)
          Converts Payment Server payment key collection to an XML element.
 
Methods inherited from class com.ibm.etill.framework.xdm.PSServerFinancialObject
addCassetteObject, getApproximateXDMSize, setCassetteExtensionObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSServerPayment

public PSServerPayment()
The default constructor. It does nothing.
Method Detail

getMerchantNumber

public String getMerchantNumber()
Gets the Merchant Number
Returns:
String the merchant number

getOrderNumber

public String getOrderNumber()
Gets the Order Number
Returns:
String the order number

getPaymentNumber

public String getPaymentNumber()
Gets the Credit Number
Returns:
String the credit number

getAccountNumber

public String getAccountNumber()
Gets the Account Number
Returns:
String the account number

getBatchNumber

public String getBatchNumber()
Gets the Batch Number
Returns:
String the batch number

getPaymentType

public String getPaymentType()
Gets the Payment Type
Returns:
String the payment type

getTimeCreated

public Timestamp getTimeCreated()
Gets the time order was created
Returns:
String the order creation time

query

public static Vector query(PaymentQueryRequest request,
                           ResultSet rs)
                    throws ETillAbortOperation
Queries database for this Payment request
Parameters:
request - A PaymentQueryRequest object
rs - A ResultSet object
Returns:
result A vector of PSServerPayment objects
Throws:
ETillAbortOperation - thrown if database errors encountered on SQL query

toXml

public com.ibm.etill.xml.parser.TXElement toXml(boolean withOrders)
Converts PSServerPayment object to an XML element
Parameters:
withOrders - A boolean flag used to indicate whether to include optional attributes in the DTD or not
Returns:
TXElement this PSServerCredit object as an XML element and subelements Change History: 38247 03/09/01 wsa Added Approval Expiration

toXmlKeysOnly

public com.ibm.etill.xml.parser.TXElement toXmlKeysOnly()
Converts only the required fields of this PSServerPayment object to an XML element.
Returns:
TXElement this PSServerPayment object as an XML element and subelements

toXMLPaymentCollection

public static com.ibm.etill.xml.parser.TXElement toXMLPaymentCollection(Enumeration payments,
                                                                        boolean withOrders,
                                                                        Enumeration orders)
Converts Payment Server credit collection to an XML element.
Parameters:
payments - A collection of payment objects
withOrders - A boolean flag used to indicate whether to include optional attributes in the DTD or not
orders - A collection of orders
Returns:
TXElement this PSServerPayment collection as an XML element and subelements

toXMLPaymentKeyCollection

public static com.ibm.etill.xml.parser.TXElement toXMLPaymentKeyCollection(Enumeration payments)
Converts Payment Server payment key collection to an XML element.
Parameters:
payments - A collection of PSServerPayment objects
Returns:
TXElement this PSServerPayment object as an XML element and subelements

getApprovalExpiry

public Timestamp getApprovalExpiry()
Gets the time payment approval is to expire @38247
Returns:
String the payment approval expiration time

getApproveTime

public Timestamp getApproveTime()
Gets the time payment was approved @38247
Returns:
String the payment approval time