com.ibm.etill.framework.cassette.query
Class CassetteExtensionObject
java.lang.Object
|
+--com.ibm.etill.framework.cassette.query.CassetteExtensionObject
- All Implemented Interfaces:
- com.ibm.etill.framework.clientapi.XDMConstants
- public class CassetteExtensionObject
- extends Object
- implements com.ibm.etill.framework.clientapi.XDMConstants
This class encapsulates a Cassette extension and
implements the XDMConstants
interface. The XDMConstants
interface defines orderStates, paymentStates, batchStates and
all the XML elements and attributes names and XML attribute values.
This class implements it to allows for easy access of these constants.
This class provides the cassette-specific extensions to some of the
Framework's primary administrative objects. For example, the Framework's
AccountAdmin
class contains the generic information describing
an account, so the cassette extension to AccountAdmin contains the cassette's
own information regarding that account.
For query commands, the cassette writer must implement a class that creates
and populates a new CassetteExtensionObject
object and then
associates it with the generic using that
object's setCassetteExtensionObject
method.
- See Also:
XDMConstants
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 |
Method Summary |
void |
addProperty(String propertyID,
Object value,
Integer displayType)
Adds a cassette property to this CassetteExtensionObject. |
void |
addProperty(String propertyID,
Object value,
Integer displayType,
String displayName,
Integer displayLength,
String displayDescription,
Integer displayMode,
String displayHelp,
Boolean required)
Adds a cassette property to this CassetteExtensionObject. |
int |
getApproximateXDMSize()
Calculates the approximate XDM size by summing
the sizes of the cassette extension properties. |
com.ibm.etill.framework.cassette.query.TXElement |
toXml()
Generates an XML document from Cassette extension properties. |
CassetteExtensionObject
public CassetteExtensionObject()
addProperty
public void addProperty(String propertyID,
Object value,
Integer displayType)
- Adds a cassette property to this CassetteExtensionObject.
- Parameters:
propertyID
- a string representing the property identifiervalue
- an Object holding the value of the property identified by propertyIDdisplayType
- an Integer representing the display type; it can take a value of
READ_WRITE, READ_ONLY, and HIDDEN
addProperty
public void addProperty(String propertyID,
Object value,
Integer displayType,
String displayName,
Integer displayLength,
String displayDescription,
Integer displayMode,
String displayHelp,
Boolean required)
- Adds a cassette property to this CassetteExtensionObject.
- Parameters:
propertyID
- a string representing the property identifiervalue
- an Object holding the value of the property identified by propertyIDdisplayType
- an Integer representing the display type; it can take a value of
READ_WRITE, READ_ONLY, and HIDDENdisplayName
- the cassette name to be displayeddisplayLength
- the length to be displayeddisplayDescription
- a brief description of the cassette to be displayeddisplayMode
- an Integer representing the mode of display; it
can be either DISPLAYMODE_BASIC, DISPLAYMODE_ADVANCED, or DISPLAYMODE_BOTHdisplayHelp
- the help text to be displayed as neededrequired
- a boolean flag indicating whether this attribute is required (TRUE) or
not (FALSE)
toXml
public com.ibm.etill.framework.cassette.query.TXElement toXml()
- Generates an XML document from Cassette extension properties.
- Returns:
- TXElement an XML document
getApproximateXDMSize
public int getApproximateXDMSize()
- Calculates the approximate XDM size by summing
the sizes of the cassette extension properties.
- Returns:
- size an int representing the XDM size in bytes