com.ibm.etill.framework.clientapi
Class PSPayment

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

public class PSPayment
extends PSObject

The PSPayment class represents a Commerce Payments Payment object. The class includes accessor methods for retrieving individual attributes of the payment 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
protected PSOrder order
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
PSPayment(Element xmlPayment)
Construct a PSPayment object.
Method Summary
java.lang.Integer getAmountExp10()
Returns the AmountExp10 attribute of the payment.
java.lang.String getApprovalExpiry()
Returns the ApprovalExpiry attribute of the payment.
java.lang.Integer getApproveAmount()
Returns the ApproveAmount attribute of the payment.
java.util.Date getApproveTime()
Returns the ApproveTime attribute of the payment.
java.lang.String getBatchNumber()
Returns the BatchNumber attribute of the payment.
java.lang.String getCurrency()
Returns the Currency attribute of the payment.
java.lang.Integer getDepositAmount()
Returns the DepositAmount attribute of the payment.
java.lang.String getMerchantAccount()
Returns the MerchantAccount attribute of the payment.
java.lang.String getMerchantNumber()
Returns the MerchantNumber attribute of the payment.
PSOrder getOrder()
Returns a particular order associated with this payment.
java.lang.String getOrderNumber()
Returns the OrderNumber attribute of the payment.
java.lang.String getPaymentNumber()
Returns the PaymentNumber attribute of the payment.
java.lang.String getPaymentType()
Returns the PaymentType attribute of the payment.
java.lang.String getReferenceNumber()
Returns the ReferenceNumber attribute of the payment.
java.lang.String getState()
Returns the CurrentState attribute of the payment.
java.util.Date getTimeCreated()
Returns the TimeCreated attribute of the payment.
java.util.Date getTimeModified()
Returns the TimeModified attribute of the payment.
protected static java.util.Hashtable processCollection(Element element)
processCollection
void setOrder(PSOrder order)
Assign the Order object to this payment.
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
Field Detail

order

protected PSOrder order
Constructor Detail

PSPayment

public PSPayment(Element xmlPayment)
Construct a PSPayment object.
Parameters:
xmlPayment - -- a XML Element of the Payment.
Method Detail

processCollection

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

getMerchantNumber

public java.lang.String getMerchantNumber()
Returns the MerchantNumber attribute of the payment.
Returns:
the merchantNumber attribute of the payment

getOrderNumber

public java.lang.String getOrderNumber()
Returns the OrderNumber attribute of the payment.
Returns:
the orderNumber attribute of the payment

getPaymentNumber

public java.lang.String getPaymentNumber()
Returns the PaymentNumber attribute of the payment.
Returns:
the PaymentNumber attribute of the payment

getPaymentType

public java.lang.String getPaymentType()
Returns the PaymentType attribute of the payment.
Returns:
the paymentType attribute of the payment; null if the attribute not returned

getApproveAmount

public java.lang.Integer getApproveAmount()
Returns the ApproveAmount attribute of the payment.
Returns:
the approveAmount attribute of the payment; null if the attribute not returned

getAmountExp10

public java.lang.Integer getAmountExp10()
Returns the AmountExp10 attribute of the payment.
Returns:
the amountExp10 attribute of the payment; null if the attribute not returned

getCurrency

public java.lang.String getCurrency()
Returns the Currency attribute of the payment.
Returns:
the currency attribute of the payment; null if the attribute not returned

getTimeCreated

public java.util.Date getTimeCreated()
Returns the TimeCreated attribute of the payment.
Returns:
the timeCreated attribute of the payment; null if the attribute not returned

getTimeModified

public java.util.Date getTimeModified()
Returns the TimeModified attribute of the payment.
Returns:
the timeModified attribute of the payment; null if the attribute not returned

getState

public java.lang.String getState()
Returns the CurrentState attribute of the payment.
Returns:
the currentState attribute of the payment; null if the attribute not returned

getBatchNumber

public java.lang.String getBatchNumber()
Returns the BatchNumber attribute of the payment.
Returns:
the batchNumber attribute of the payment; null if the attribute not returned

getReferenceNumber

public java.lang.String getReferenceNumber()
Returns the ReferenceNumber attribute of the payment.
Returns:
the referenceNumber attribute of the payment; null if the attribute not returned

getDepositAmount

public java.lang.Integer getDepositAmount()
Returns the DepositAmount attribute of the payment.
Returns:
the depositAmount attribute of the payment; null if the attribute not returned

getMerchantAccount

public java.lang.String getMerchantAccount()
Returns the MerchantAccount attribute of the payment.
Returns:
the merchantAccount attribute of the payment; null if the attribute not returned

getOrder

public PSOrder getOrder()
Returns a particular order associated with this payment.
Returns:
the order with this payment; null if order does not exist or was not returned with the payment.

setOrder

public void setOrder(PSOrder order)
Assign the Order object to this payment.
Parameters:
order - -- Order object to be set.

getApprovalExpiry

public java.lang.String getApprovalExpiry()
Returns the ApprovalExpiry attribute of the payment. @38247
Returns:
the approvalExpiry attribute of the payment; null if the attribute not returned

getApproveTime

public java.util.Date getApproveTime()
Returns the ApproveTime attribute of the payment. @38247
Returns:
the approveTime attribute of the payment; null if the attribute not returned

Feedback