com.ibm.etill.framework.xdm
Class PSServerOrder

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

public final class PSServerOrder
extends PSServerFinancialObject
implements PSServerOrderConstants


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerOrderConstants
APPROXIMATE_XDM_KEY_SIZE, APPROXIMATE_XDM_OBJECT_SIZE, COL_ACCOUNTNUMBER, COL_AMOUNTEXP10, COL_AMOUNTVALUE, COL_APPROVEFLAG, COL_APPROVESALLOWED, COL_BATCHID, COL_BATCHNUMBER, COL_BATCHREQUIRED, COL_CANCELURL, COL_CARDHOLDERID, COL_CTYPECHARSET, COL_CURRENCY, COL_CURRENTSTATE, COL_DEPOSITFLAG, COL_FAILUREURL, COL_INITIALPAYMENT, COL_MERCHANTNAME, COL_ORDERDATA1, COL_ORDERDATA2, COL_ORDERDATA3, COL_ORDERDATA4, COL_ORDERDATA5, COL_ORDERDESCRIPTION, COL_ORDERNUMBER, COL_ORDERURL, COL_ORIGIN, COL_PAYMENTAMOUNT, COL_PAYMENTTYPE, COL_PAYREQPERSISTFDSKEY, COL_SERVICEURL, COL_SPLITSALLOWED, COL_SUCCESSURL, COL_TIMESTAMPCREATED, COL_TIMESTAMPMODIFIED, COL_TRANSACTIONID, COL_UNAPPROVEDAMOUNT, ORDER, ORDERVIEW, VIEW_ACCOUNTNUMBER, VIEW_AMOUNTEXP10, VIEW_APPROVESALLOWED, VIEW_BATCHREQUIRED, VIEW_CANCELURL, VIEW_CARDHOLDERID, VIEW_CTYPECHARSET, VIEW_CURRENCY, VIEW_FAILUREURL, VIEW_MERCHANTNAME, VIEW_ORDERAMOUNT, VIEW_ORDERDATA1, VIEW_ORDERDATA2, VIEW_ORDERDATA3, VIEW_ORDERDATA4, VIEW_ORDERDATA5, VIEW_ORDERDESCRIPTION, VIEW_ORDERNUMBER, VIEW_ORDERSTATE, VIEW_ORDERTIMECREATED, VIEW_ORDERTIMEMODIFIED, VIEW_ORDERURL, VIEW_ORIGIN, VIEW_PAYMENTTYPE, VIEW_SERVICEURL, VIEW_SUCCESSURL, VIEW_TRANSACTIONID, 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
PSServerOrder()
          The default constructor.
 
Method Summary
static void combineQueryResults(Vector orders, Vector payments, Vector credits)
          Builds a table of Orders with associated credits and payments
 String getCancelURL()
           
 String getContentTypeCharSet()
           
 String getFailureURL()
           
 String getMerchantNumber()
           
 byte[] getOrderDescription()
           
 String getOrderNumber()
           
 String getPaymentType()
           
 String getServiceURL()
           
 String getSuccessURL()
           
 Timestamp getTimeCreated()
           
static Vector query(OrderQueryRequest request, ResultSet rs)
          Builds a PSServerOrder vector from the results of a database query
 com.ibm.etill.xml.parser.TXElement toXml(boolean withPayments, boolean withCredits)
          Returns this PSServerOrder object as an XML element
 com.ibm.etill.xml.parser.TXElement toXmlKeysOnly()
          Converts only the required fields of this PSServerOrder object to an XML element.
static com.ibm.etill.xml.parser.TXElement toXMLOrderCollection(Enumeration orders, boolean withPayments, boolean withCredits)
          Converts Payment Server order collection to an XML element.
static com.ibm.etill.xml.parser.TXElement toXMLOrderKeyCollection(Enumeration orders)
          Converts Payment Server order 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

PSServerOrder

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

getMerchantNumber

public String getMerchantNumber()

getOrderNumber

public String getOrderNumber()

getPaymentType

public String getPaymentType()

getSuccessURL

public String getSuccessURL()

getFailureURL

public String getFailureURL()

getCancelURL

public String getCancelURL()

getServiceURL

public String getServiceURL()

getOrderDescription

public byte[] getOrderDescription()

getContentTypeCharSet

public String getContentTypeCharSet()

getTimeCreated

public Timestamp getTimeCreated()

query

public static Vector query(OrderQueryRequest request,
                           ResultSet rs)
                    throws ETillAbortOperation
Builds a PSServerOrder vector from the results of a database query
Parameters:
request - An OderQueryRequest object
rs - A ResultSet object
Returns:
result A collection of PSServerOrder objects.
Throws:
ETillAbortOperation - thrown if database errors are encountered.

toXml

public com.ibm.etill.xml.parser.TXElement toXml(boolean withPayments,
                                                boolean withCredits)
Returns this PSServerOrder object as an XML element
Parameters:
withPayments - A boolean variable indicating the inclusion of payments
withCredits - A boolean variable indicating the inclusionof credits
Returns:
TXElement An XML document element

toXmlKeysOnly

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

toXMLOrderCollection

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

toXMLOrderKeyCollection

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

combineQueryResults

public static void combineQueryResults(Vector orders,
                                       Vector payments,
                                       Vector credits)
Builds a table of Orders with associated credits and payments
Parameters:
orders - A list of orders
payments - A list of payments
credits - A list of crdits