|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.etill.framework.cassette.query.CassetteObject
CassetteObject returns data from cassette-specific financial objects through
the query API command set. CassetteObject should be used to return data
from CassetteOrder
, CassetteTransaction
and CassetteBatch
objects to merchant applications and the
Commerce Payments User Interface.
Each data item to be returned is first wrapped in a CassetteProperty
object. That object is then added to this CassetteObject for return to the
requesting application.
When the current query API request completes, an XML document containing the
results will be sent back to the requesting application. This object will be
represented by a PSCassetteObject
element as follows:
<PSCassetteObject objectId="objectId" key="key">
<PackagedContent>packagedContent</PackagedContent>
</PSCassetteObject>
if the PackagedContent element is present. The PackagedContent element
is present only if the CassetteObject
is contructed with it.
CassetteProperty
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 | |
---|---|
CassetteObject(String objectID,
String key)
Constructs a CassetteObject object with specified object identifier and key. |
|
CassetteObject(String objectID,
String key,
byte[] packagedContent)
Constructs a CassetteObject object with specified object identifier, key and packagedContent. |
Method Summary | |
---|---|
void |
addProperty(String propertyID,
Object value,
Integer displayType)
Adds a new field to this CassetteObject object. |
void |
addProperty(String propertyID,
Object value,
Integer displayType,
String displayName,
Integer displayLength,
String displayDescription,
Integer displayMode,
String displayHelp,
Boolean required)
Adds a new field, including all of the specified display parameters, to this CassetteObject object. |
int |
getApproximateXDMSize()
Gets the approximate size of all the CassetteProperty objects contained in this query request. |
com.ibm.etill.framework.cassette.query.TXElement |
toXml()
Generates XML to represent this object in a Payment Server query API response. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CassetteObject(String objectID, String key, byte[] packagedContent)
objectID
- the String to be used as the objectId
value
in the resulting XML elementkey
- the String to be used as the key
value
in the resulting XML elementpackagedContent
- a byte array that contains the value to be contained
within the PSCassetteObject
element that
will represent this object; if this parameter is null,
the no packaged content subelement will be generatedpublic CassetteObject(String objectID, String key)
objectID
- the String to be used as the objectId
value
in the resulting XML elementkey
- the String to be used as the key
value
in the resulting XML elementMethod Detail |
public void addProperty(String propertyID, Object value, Integer displayType)
propertyId
- the String to be used as the propertyId
value
in the resulting XML elementvalue
- an Object that contains the value of this propertydisplayType
- an Integer that contains the display type code; if
null is passed here, then no displayType
attribute will be included in the resulting XML elementpublic void addProperty(String propertyID, Object value, Integer displayType, String displayName, Integer displayLength, String displayDescription, Integer displayMode, String displayHelp, Boolean required)
propertyId
- the String to be used as the propertyId
value
in the resulting XML element.value
- an Object that contains the value of this property.displayType
- an Integer that contains the display type code. If
null is passed here, then the displayType
attribute will be included in the resulting XML element.displayName
- a String that contains the text which the Payment Server
User Interface will display as the field name for this value.displayLength
- an Integer that contains the number of displayable characters
for the property. If null is specified, then the Commerce
Payments User Interface will determine the appropriate display
length.displayDescription
- a String that contains the text which the Commerce Payments
User Interface will display as the field description.displayMode
- an Integer that contains the text mode for this field. Valid
values are
displayHelp
- a String that contains the help text which the Commerce Payments
User Interface will display for this field.required
- a boolean value; true
means that this is a required
field, false
means it is not.public com.ibm.etill.framework.cassette.query.TXElement toXml()
toXml
method of each CassetteProperty
object referenced.
Cassettes should not call this method directly. Rather this is a helper method used by the framework to convert query results into an XML document returned as API response.
Note: this method assumes the use of IBM's XML for Java parser, which is present on every machine on which the Payment Server Framework is installed.
public int getApproximateXDMSize()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |