com.ibm.etill.framework.clientapi
Class PSProperty
java.lang.Object
com.ibm.etill.framework.clientapi.PSProperty
- All Implemented Interfaces:
- XDMConstants
- public class PSProperty
- extends java.lang.Object
- implements XDMConstants
The PSProperty class represents a Commerce Payments cassette property. The property represents a name-value pair returned from the cassette. Other information associated with the property is represented in this class as well.
Field Summary |
static java.lang.Integer |
ADVANCED
|
static java.lang.Integer |
BASIC
|
static java.lang.Integer |
BOTH
|
static java.lang.Integer |
HIDDEN
|
static java.lang.Integer |
READONLY
|
static java.lang.Integer |
READWRITE
|
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 |
PSProperty(Element cassetteProperty)
Construct a PSProperty object |
PSProperty(java.lang.String propertyID, java.lang.Object value)
Construct a PSProperty object with the property id and the property value. |
PSProperty(java.lang.String propertyID, java.lang.Object value, java.lang.String displayType)
Construct a PSProperty object with the property id, the property value and the display type. |
PSProperty(java.lang.String propertyID, java.lang.Object value, java.lang.String displayType, java.lang.String displayName, java.lang.String displayLength, java.lang.String displayDescription, java.lang.String displayMode, java.lang.String displayHelp, java.lang.Boolean required)
Construct a PSProperty object with the property id, the property value, the display type, etc. |
Method Summary |
java.lang.String |
getDisplayDescription()
Returns the other description of the property to be displayed. |
java.lang.String |
getDisplayHelp()
Returns the help information of the property to be displayed. |
java.lang.Integer |
getDisplayLength()
Returns the length of the property name to be displayed. |
java.lang.Integer |
getDisplayMode()
Returns the mode of the property. |
java.lang.String |
getDisplayName()
Returns the name of the property to be displayed. |
java.lang.Integer |
getDisplayType()
Returns the display type of the property. |
java.lang.String |
getPropertyID()
Returns the identification name of the property. |
java.lang.Boolean |
getRequired()
Returns whether the property is required in the assciated object. |
java.lang.Object |
getValue()
Returns the value of the property. |
java.lang.String |
toString()
Returns the string represention of the property. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
READWRITE
public static final java.lang.Integer READWRITE
READONLY
public static final java.lang.Integer READONLY
HIDDEN
public static final java.lang.Integer HIDDEN
BASIC
public static final java.lang.Integer BASIC
ADVANCED
public static final java.lang.Integer ADVANCED
BOTH
public static final java.lang.Integer BOTH
PSProperty
public PSProperty(java.lang.String propertyID,
java.lang.Object value)
- Construct a PSProperty object with the property id and the property value.
- Parameters:
- propertyID - -- name of the property.
- value - -- value of the property.
PSProperty
public PSProperty(java.lang.String propertyID,
java.lang.Object value,
java.lang.String displayType)
- Construct a PSProperty object with the property id, the property value and the display type.
- Parameters:
- propertyID - -- name of the property.
- value - -- value of the property.
- displayType - -- display type of the property.
PSProperty
public PSProperty(java.lang.String propertyID,
java.lang.Object value,
java.lang.String displayType,
java.lang.String displayName,
java.lang.String displayLength,
java.lang.String displayDescription,
java.lang.String displayMode,
java.lang.String displayHelp,
java.lang.Boolean required)
- Construct a PSProperty object with the property id, the property value, the display type, etc.
- Parameters:
- propertyID - -- name of the property.
- value - -- value of the property.
- displayType - -- display type of the property.
- displayName - -- name to be displayed for the property.
- displayLength - -- length to be displayed for the property.
- displayDescription - -- description of the property
- displayMode - -- mode of the property
- displayHelp - -- help information to be displayed.
- required - -- whether the property is required or optional.
PSProperty
public PSProperty(Element cassetteProperty)
- Construct a PSProperty object
- Parameters:
- cassetteProperty - -- an XML element of the cassette property representation.
getPropertyID
public java.lang.String getPropertyID()
- Returns the identification name of the property.
-
- Returns:
- the propertyID of the property.
getValue
public java.lang.Object getValue()
- Returns the value of the property.
-
- Returns:
- the value of the property.
getDisplayType
public java.lang.Integer getDisplayType()
- Returns the display type of the property.
-
- Returns:
- the displayType of the property.
getDisplayName
public java.lang.String getDisplayName()
- Returns the name of the property to be displayed.
-
- Returns:
- the displayName of the property.
getDisplayLength
public java.lang.Integer getDisplayLength()
- Returns the length of the property name to be displayed.
-
- Returns:
- the displayLength of the property.
getDisplayDescription
public java.lang.String getDisplayDescription()
- Returns the other description of the property to be displayed.
-
- Returns:
- the displayDescription of the property.
getDisplayMode
public java.lang.Integer getDisplayMode()
- Returns the mode of the property.
-
- Returns:
- the displayMode of the property.
getDisplayHelp
public java.lang.String getDisplayHelp()
- Returns the help information of the property to be displayed.
-
- Returns:
- the displayHelp of the property.
getRequired
public java.lang.Boolean getRequired()
- Returns whether the property is required in the assciated object.
-
- Returns:
- the required field of object.
toString
public java.lang.String toString()
- Returns the string represention of the property.
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.