com.ibm.etill.framework.clientapi
Class PSUserInfo

java.lang.Object
  com.ibm.etill.framework.clientapi.PSObject
      com.ibm.etill.framework.clientapi.PSAdminObject
          com.ibm.etill.framework.clientapi.PSUserInfo
All Implemented Interfaces:
XDMConstants

public class PSUserInfo
extends PSAdminObject

The PSUserInfo class represents a Commerce Payments User administration object. The class includes accessor methods for retrieving individual attributes of the administration object. In addition, attributes can be retrieved using the getProperty methods of PSObject.

See Also:
PSObject.getProperty(java.lang.String)

Nested Class Summary
Nested classes inherited from class com.ibm.etill.framework.clientapi.PSObject
PSObject.PSObjectKey
Field Summary
Fields inherited from class com.ibm.etill.framework.clientapi.PSAdminObject
cassetteMessages
Fields inherited from class com.ibm.etill.framework.clientapi.PSObject
cassetteObjects, objectKey, objectName, TYPE_BOOLEAN, TYPE_DATE, TYPE_INTEGER, TYPE_LONG, TYPE_STRING
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
protected PSUserInfo(Element xml)
Constructor
Method Summary
java.lang.Integer getConfigurationFlag()
Returns the current configuration state of this user.
java.lang.String getMerchantNumber()
Returns the merchant number associated with this user
java.lang.String getUserName()
Returns the user name of this user
java.lang.Boolean isClerk()
Is this user a clerk?
java.lang.Boolean isMerchantAdministrator()
Is this user a merchant administrator?
java.lang.Boolean isPaymentServerAdministrator()
Is this user a Commerce Payments administrator?
java.lang.Boolean isSupervisor()
Is this user a supervisor?
protected static java.util.Hashtable processCollection(Element element)
processCollection
Methods inherited from class com.ibm.etill.framework.clientapi.PSAdminObject
getActive, getCassetteMessages, getChangesPending, getEnabled, getFrameworkMessages, getValid, processCassetteConfigObjects, processMessages
Methods inherited from class com.ibm.etill.framework.clientapi.PSObject
getCassetteObjects, getName, getProperties, getProperty, getPropertyValue, processCassetteExtension, processCassetteObjects, processCollection, processElement, processElement, setProperty, setProperty, setProperty
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PSUserInfo

protected PSUserInfo(Element xml)
Constructor
Method Detail

processCollection

protected static java.util.Hashtable processCollection(Element element)
processCollection

getUserName

public java.lang.String getUserName()
Returns the user name of this user
Returns:
the userName attribute of this user

getMerchantNumber

public java.lang.String getMerchantNumber()
Returns the merchant number associated with this user
Returns:
the merchantNumber attribute of this user; null if the attribute not returned

isPaymentServerAdministrator

public java.lang.Boolean isPaymentServerAdministrator()
Is this user a Commerce Payments administrator?
Returns:
true if user is a Commerce Payments administrator; null if the attribute not returned

isMerchantAdministrator

public java.lang.Boolean isMerchantAdministrator()
Is this user a merchant administrator?
Returns:
true if user is a merchant administrator; null if the attribute not returned

isSupervisor

public java.lang.Boolean isSupervisor()
Is this user a supervisor?
Returns:
true if user is a supervisor; null if the attribute not returned

isClerk

public java.lang.Boolean isClerk()
Is this user a clerk?
Returns:
true if user is a clerk; null if the attribute not returned

getConfigurationFlag

public java.lang.Integer getConfigurationFlag()
Returns the current configuration state of this user.
  • 0 - properly configured
  • 1 - misconfigured
  • 2 - properly configured, but no access rights
    Returns:
    the configurationFlag attribute of this user

Feedback