com.ibm.etill.framework.cassette.query
Class CassetteConfigObject

java.lang.Object
  |
  +--com.ibm.etill.framework.cassette.query.CassetteConfigObject
All Implemented Interfaces:
com.ibm.etill.framework.clientapi.XDMConstants

public class CassetteConfigObject
extends Object
implements com.ibm.etill.framework.clientapi.XDMConstants

This class provides the XDM view of a cassette's primary admin object, that is, an admin object that the cassette has "invented", like the Brand object for the SET, CyberCash, and Test cassettes.


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
CassetteConfigObject(String objectID, String key, boolean changesPending, boolean enabled, boolean active, boolean valid)
          The only constructor provided by this class.
 
Method Summary
 void addMessage(String messageNumber)
          Adds a message to the Vector of messages.
 void addProperty(String propertyID, Object value, Integer displayType)
          Adds a cassette property to this CassetteConfigObject.
 void addProperty(String propertyID, Object value, Integer displayType, String displayName, Integer displayLength, String displayDescription, Integer displayMode, String displayHelp, Boolean required)
          Adds Cassette properties.
 int getApproximateXDMSize()
          Calculates the approximate XDM size by summing the sizes of the cassette config properties.
 com.ibm.etill.framework.cassette.query.TXElement toXml()
          Generates an XML document from Cassette config properties.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CassetteConfigObject

public CassetteConfigObject(String objectID,
                            String key,
                            boolean changesPending,
                            boolean enabled,
                            boolean active,
                            boolean valid)
The only constructor provided by this class. It initializes the Cassette attributes.
Parameters:
objectID - a String identifying this Cassette
key - a String used as key for quick lookup of the Cassette
changesPending - a boolean attribute use to indicate changes pending or not
enabled - a boolean attribute use to indicate whether the Cassette is anabled or not
active - a boolean attribute use to indicate whether the Cassette is active
valid - a boolean attribute use to indicate the validity of the Cassette
Method Detail

addProperty

public void addProperty(String propertyID,
                        Object value,
                        Integer displayType)
Adds a cassette property to this CassetteConfigObject.
Parameters:
propertyID - a string representing the property identifier
value - an Object holding the value of the property identified by propertyID
displayType - 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 Cassette properties. It validates the property by checking to make sure that it is not null. If the property is not null and it has value associated with it, then it stores the property.
Parameters:
propertyID - a string representing the property identifier
value - an Object holding the value of the property identified by propertyID
displayType - an Integer representing the display type; it can take a value of READ_WRITE, READ_ONLY, and HIDDEN
displayName - the cassette name to be displayed
displayLength - the length to be displayed
displayDescription - a brief description of the cassette to be displayed
displayMode - an Integer representing the mode of display; it can be either DISPLAYMODE_BASIC, DISPLAYMODE_ADVANCED, or DISPLAYMODE_BOTH
displayHelp - the help text to be displayed as needed
required - a boolean flag indicating whether this attribute is required (TRUE) or not (FALSE)

addMessage

public void addMessage(String messageNumber)
Adds a message to the Vector of messages. This could be a new error code or any other return code that has meaning to the cassette writer.
Parameters:
messageNumber - a String identifying the message number

toXml

public com.ibm.etill.framework.cassette.query.TXElement toXml()
Generates an XML document from Cassette config properties.
Returns:
TXElement an XML document

getApproximateXDMSize

public int getApproximateXDMSize()
Calculates the approximate XDM size by summing the sizes of the cassette config properties.
Returns:
size an int representing the XDM size in bytes