com.ibm.etill.framework.xdm
Class PaymentSystemQueryRequest

java.lang.Object
  |
  +--com.ibm.etill.framework.xdm.QueryRequest
        |
        +--com.ibm.etill.framework.xdm.PaymentSystemQueryRequest
All Implemented Interfaces:
FrameworkReturnCodes, PaymentAPIConstants, PSServerPaymentSystemConstants, QueryRequestConstants, com.ibm.etill.framework.clientapi.XDMConstants

public class PaymentSystemQueryRequest
extends QueryRequest
implements PSServerPaymentSystemConstants

It is a subclass of the QueryRequest class and it encapsulates the query payment system command with all of its parameters. This class is used primarily by the Framework.

See Also:
QueryRequest

Fields inherited from interface com.ibm.etill.framework.xdm.PSServerPaymentSystemConstants
APPROXIMATE_XDM_OBJECT_SIZE, COL_CASSETTENAME, COL_MERCHANTNUMBER, PaySystemTable
 
Fields inherited from interface com.ibm.etill.framework.xdm.QueryRequestConstants
DTD_SIZE, QUERY_ACCOUNTNUMBER, QUERY_AMOUNTEXP10, QUERY_APPROVESALLOWED, QUERY_BATCHNUMBER, QUERY_BEGINTIME, QUERY_BRAND, QUERY_CASSETTENAME, QUERY_CLOSEALLOWED, QUERY_CLOSEBEGINTIME, QUERY_CLOSEENDTIME, QUERY_CREATEBEGINTIME, QUERY_CREATEENDTIME, QUERY_CREDITNUMBER, QUERY_CURRENCY, QUERY_DTDPATH, QUERY_ENDTIME, QUERY_EVENTTYPE, QUERY_FILTER, QUERY_KEYSONLY, QUERY_LISTENERURL, QUERY_MAX_KEYS_TO_RETURN, QUERY_MAX_OBJECTS_TO_RETURN, QUERY_MAXAMOUNT, QUERY_MAXAPPROVEAMOUNT, QUERY_MAXDEPOSITAMOUNT, QUERY_MAXUNAPPROVEDAMOUNT, QUERY_MERCHANTNUMBER, QUERY_MINAMOUNT, QUERY_MINAPPROVEAMOUNT, QUERY_MINDEPOSITAMOUNT, QUERY_MINUNAPPROVEDAMOUNT, QUERY_MODIFYBEGINTIME, QUERY_MODIFYENDTIME, QUERY_OPENBEGINTIME, QUERY_OPENENDTIME, QUERY_ORDERDATA1, QUERY_ORDERNUMBER, QUERY_PAYMENTNUMBER, QUERY_PAYMENTTYPE, QUERY_PURGEALLOWED, QUERY_REFERENCENUMBER, QUERY_RETURNATMOST, QUERY_ROLE, QUERY_STATE, QUERY_STATUS, QUERY_TIMEREGISTERED, QUERY_TRANSACTIONID, QUERY_USERNAME, QUERY_VERSION, QUERY_WITHCREDITS, QUERY_WITHORDERS, QUERY_WITHPAYMENTS
 
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
PaymentSystemQueryRequest()
          The default constructor retrieves all records.
PaymentSystemQueryRequest(String command, Hashtable parameters)
          Constructs the superclass and itself using the input parameters below.
 
Method Summary
 String[] getCassetteNames()
          Gets cassette names.
 String[] getMerchantNumbers()
          Gets merchant numbers.
 String whereCondition()
          Builds the where-condition that will be used by the Framework to query the set of PSServerPaymentSystem objects being requested.
 
Methods inherited from class com.ibm.etill.framework.xdm.QueryRequest
getApproximateXDMSize, getCommand, getDTDPath, getKeysOnly, getKeywords, getObjects, getOriginalRequest, getResultCount, getShowSensitiveData, queryCassettes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PaymentSystemQueryRequest

public PaymentSystemQueryRequest(String command,
                                 Hashtable parameters)
                          throws ETillAbortOperation
Constructs the superclass and itself using the input parameters below. The input parameters are validated and then used to set the object properties. It also issues the query command. The constructor should only be called by the Framework.
Parameters:
command - a string representing the command
parameters - a hash table of name-value pairs
Throws:
ETillAbortOperation - thrown if catastrophic errors are encountered

PaymentSystemQueryRequest

public PaymentSystemQueryRequest()
                          throws ETillAbortOperation
The default constructor retrieves all records.
Throws:
ETillAbortOperation - thrown if catastrophic errors are encountered
Method Detail

getCassetteNames

public String[] getCassetteNames()
Gets cassette names.
Returns:
String[] an array of cassette names

getMerchantNumbers

public String[] getMerchantNumbers()
Gets merchant numbers.
Returns:
String[] an array of merchant numbers

whereCondition

public String whereCondition()
Builds the where-condition that will be used by the Framework to query the set of PSServerPaymentSystem objects being requested. Cassettes should not call this method, only the Framework has a need to.
Overrides:
whereCondition in class QueryRequest
Returns:
String the where condition string