com.ibm.etill.framework.xdm
Class PSServerBatch

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

public final class PSServerBatch
extends PSServerFinancialObject
implements PSServerBatchConstants

This class encapsulates the standard parameters that are required for all queries on batch processing.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerBatchConstants
APPROXIMATE_XDM_OBJECT_SIZE, BATCH, BATCHCREDITVIEW, BATCHPAYMENTVIEW, BATCHVIEW, COL_ACCOUNTNUMBER, COL_BATCHID, COL_BATCHNUMBER, COL_CLOSEALLOWED, COL_CURRENTSTATE, COL_GROWTH1, COL_MERCHANTNAME, COL_PAYMENTTYPE, COL_PURGEALLOWED, COL_STATUS, COL_TIMECLOSED, COL_TIMECREATED, COL_TIMEMODIFIED, COL_TOTALSFD, COL_TOTALSKEY, COL_UNIQUEKEY, MAXBATCHVIEW, VIEW_ACCOUNTNUMBER, VIEW_BATCHNUMBER, VIEW_CLOSEALLOWED, VIEW_GROWTH1, VIEW_MAXBATCHNUMBER, VIEW_MERCHANTNAME, VIEW_PAYMENTTYPE, VIEW_PURGEALLOWED, VIEW_STATE, VIEW_STATUS, VIEW_TIMECLOSED, VIEW_TIMECREATED, VIEW_TIMEMODIFIED, VIEW_TOTALS
 
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
PSServerBatch()
          The default constructor does nothing.
 
Method Summary
static void combineQueryResults(Vector batches, Vector payments, Vector credits)
          Builds a hash table of payments and credits bound to batches.
 String getAccountNumber()
          Gets this account number.
 String getBatchNumber()
          Gets this batch number.
 Vector getBatchTotalsCollection()
          Gets this batch totals collection.
 Vector getCreditCollection()
          Gets this credit collection.
 String getMerchantNumber()
          Gets this merchant number.
 Vector getPaymentCollection()
          Gets this payment collection.
 String getPaymentType()
          Gets this payment type.
 Timestamp getTimeOpened()
          Gets the time this batch was opened.
static Vector query(BatchQueryRequest request, ResultSet rs)
          Queries Payment System for batch request.
 com.ibm.etill.xml.parser.TXElement toXml(boolean withPayments, boolean withCredits)
          Converts this object as an XML element
static com.ibm.etill.xml.parser.TXElement toXMLBatchCollection(Enumeration batches, boolean withPayments, boolean withCredits)
          Converts only the required fields of this PSServerBatch object to an XML element.
static com.ibm.etill.xml.parser.TXElement toXMLBatchKeyCollection(Enumeration batches)
          Converts only the required fields of this PSServerBatch object to an XML element.
 com.ibm.etill.xml.parser.TXElement toXmlKeysOnly()
          Converts only the required fields of this PSServerBatch object 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

PSServerBatch

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

getMerchantNumber

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

getAccountNumber

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

getBatchNumber

public String getBatchNumber()
Gets this batch number.
Returns:
String The batch number.

getPaymentCollection

public Vector getPaymentCollection()
Gets this payment collection.
Returns:
paymentCollection A vector of payment collection.

getCreditCollection

public Vector getCreditCollection()
Gets this credit collection.
Returns:
creditCollection A vector of credit collection.

getBatchTotalsCollection

public Vector getBatchTotalsCollection()
Gets this batch totals collection.
Returns:
batchTotalsCollection A vector of batch totals collection.

getPaymentType

public String getPaymentType()
Gets this payment type.
Returns:
String The payment system name.

getTimeOpened

public Timestamp getTimeOpened()
Gets the time this batch was opened.
Returns:
Timestamp The time batch was opened.

query

public static Vector query(BatchQueryRequest request,
                           ResultSet rs)
                    throws ETillAbortOperation
Queries Payment System for batch request.
Parameters:
request - A BatchQueryRequest object.
rs - A database query output object.
Returns:
result A vector containing query output.
Throws:
ETillAbortOperation - if a database error is encountered.

toXml

public com.ibm.etill.xml.parser.TXElement toXml(boolean withPayments,
                                                boolean withCredits)
Converts this object as an XML element
Parameters:
withPayments - A boolean variable. TRUE means include payments to the XML document.
withCredits - A boolean variable. TRUE means include credits to the XML document.
Returns:
xmlBatch The XML document.

toXmlKeysOnly

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

toXMLBatchCollection

public static com.ibm.etill.xml.parser.TXElement toXMLBatchCollection(Enumeration batches,
                                                                      boolean withPayments,
                                                                      boolean withCredits)
Converts only the required fields of this PSServerBatch object to an XML element.
Parameters:
batches - this PSServerBatch hash table elements.
withPayments - If TRUE then include payments in XML document.
withCredits - If TRUE then include credits in XML document
Returns:
collection this PSServerBatch object as an XML document

toXMLBatchKeyCollection

public static com.ibm.etill.xml.parser.TXElement toXMLBatchKeyCollection(Enumeration batches)
Converts only the required fields of this PSServerBatch object to an XML element.
Parameters:
batches - this PSServerBatch hash table elements.
Returns:
collection this PSServerBatch object as an XML document

combineQueryResults

public static void combineQueryResults(Vector batches,
                                       Vector payments,
                                       Vector credits)
Builds a hash table of payments and credits bound to batches.
Parameters:
batches - A vector of PSServerBatch.
payments - A vector of PSServerPayment.
credits - A vector of PSServerCredit.