com.ibm.etill.framework.clientapi
Class PSOrder
java.lang.Object
com.ibm.etill.framework.clientapi.PSObject
com.ibm.etill.framework.clientapi.PSOrder
- All Implemented Interfaces:
- XDMConstants
- public class PSOrder
- extends PSObject
The PSOrder class represents a Commerce Payments Order object. The class includes accessor methods for retrieving individual attributes of the order object. In addition, attributes can be retrieved using the getProperty methods of PSObject.
- See Also:
- PSObject.getProperty(java.lang.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 |
PSOrder(Element xmlOrder)
Construct a PSOrder object. |
Method Summary |
java.util.Enumeration |
enumerateCredits()
Returns an enumeration of all credits returned with this order. |
java.util.Enumeration |
enumeratePayments()
Returns an enumeration of all payments returned with this order. |
java.lang.Integer |
getAmount()
Returns the Amount attribute of the order. |
java.lang.Integer |
getAmountExp10()
Returns the AmountExp10 attribute of the order. |
java.lang.Boolean |
getApprovesAllowed()
Returns the ApprovesAllowed attribute of the order. |
java.lang.String |
getBrand()
Returns the Brand attribute of the order. |
PSCredit |
getCredit(java.lang.String creditNumber)
Returns a particular credit associated with this order. |
java.lang.String |
getCurrency()
Returns the Currency attribute of the order. |
java.lang.String |
getMerchantAccount()
Returns the MerchantAccount attribute of the order. |
java.lang.String |
getMerchantNumber()
Returns the MerchantNumber attribute of the order. |
java.lang.Boolean |
getMerchantOriginated()
Returns the MerchantOriginated attribute of the order. |
java.lang.String |
getOrderData1()
Returns the orderData1 attribute of the order. |
java.lang.String |
getOrderData2()
Returns the orderData2 attribute of the order. |
java.lang.String |
getOrderData3()
Returns the orderData3 attribute of the order. |
byte[] |
getOrderData4()
Returns the orderData4 attribute of the order. |
byte[] |
getOrderData5()
Returns the orderData5 attribute of the order. |
java.lang.String |
getOrderNumber()
Returns the OrderNumber attribute of the order. |
java.lang.String |
getOrderURL()
Returns the OrderURL attribute of the order. |
PSPayment |
getPayment(java.lang.String paymentNumber)
Returns a particular payment associated with this order. |
java.lang.String |
getPaymentType()
Returns the PaymentType attribute of the order. |
java.lang.String |
getState()
Returns the CurrentState attribute of the order. |
java.util.Date |
getTimeCreated()
Returns the TimeCreated attribute of the order. |
java.util.Date |
getTimeModified()
Returns the TimeModified attribute of the order. |
java.lang.String |
getTransactionID()
Returns the transactionID attribute of the order. |
java.lang.Integer |
getUnapprovedAmount()
Returns the unapproved amount attribute of the order. |
int |
numberOfCredits()
Returns the number of credits returned with this order. |
int |
numberOfPayments()
Returns the number of payments returned with this order. |
protected static java.util.Hashtable |
processCollection(Element element)
processCollection |
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 |
paymentCollection
protected java.util.Hashtable paymentCollection
creditCollection
protected java.util.Hashtable creditCollection
PSOrder
protected PSOrder(Element xmlOrder)
- Construct a PSOrder object.
- Parameters:
- xmlOrder - -- a XML element of the Order.
processCollection
protected static java.util.Hashtable processCollection(Element element)
- processCollection
getMerchantNumber
public java.lang.String getMerchantNumber()
- Returns the MerchantNumber attribute of the order.
-
- Returns:
- the merchantNumber attribute of the order
getOrderNumber
public java.lang.String getOrderNumber()
- Returns the OrderNumber attribute of the order.
-
- Returns:
- the orderNumber attribute of the order
getMerchantOriginated
public java.lang.Boolean getMerchantOriginated()
- Returns the MerchantOriginated attribute of the order.
-
- Returns:
- the orderNumber attribute of the order; null if the attribute not returned
getAmount
public java.lang.Integer getAmount()
- Returns the Amount attribute of the order.
-
- Returns:
- the amount attribute of the order; null if the attribute not returned
getAmountExp10
public java.lang.Integer getAmountExp10()
- Returns the AmountExp10 attribute of the order.
-
- Returns:
- the amountExp10 attribute of the order; null if the attribute not returned
getCurrency
public java.lang.String getCurrency()
- Returns the Currency attribute of the order.
-
- Returns:
- the currency attribute of the order; null if the attribute not returned
getPaymentType
public java.lang.String getPaymentType()
- Returns the PaymentType attribute of the order.
-
- Returns:
- the paymentType attribute of the order; null if the attribute not returned
getTimeCreated
public java.util.Date getTimeCreated()
- Returns the TimeCreated attribute of the order.
-
- Returns:
- the timeCreated attribute of the order; null if the attribute not returned
getTimeModified
public java.util.Date getTimeModified()
- Returns the TimeModified attribute of the order.
-
- Returns:
- the timeModified attribute of the order; null if the attribute not returned
getState
public java.lang.String getState()
- Returns the CurrentState attribute of the order.
-
- Returns:
- the currentState attribute of the order; null if the attribute not returned
getBrand
public java.lang.String getBrand()
- Returns the Brand attribute of the order.
-
- Returns:
- the brand attribute of the order; null if the attribute not returned
getOrderURL
public java.lang.String getOrderURL()
- Returns the OrderURL attribute of the order.
-
- Returns:
- the orderURL attribute of the order; null if the attribute not returned
getTransactionID
public java.lang.String getTransactionID()
- Returns the transactionID attribute of the order.
-
- Returns:
- the transactionID attribute of the order; null if the attribute not returned
getOrderData1
public java.lang.String getOrderData1()
- Returns the orderData1 attribute of the order.
-
- Returns:
- the orderData1 attribute of the order; null if the attribute not returned
getOrderData2
public java.lang.String getOrderData2()
- Returns the orderData2 attribute of the order.
-
- Returns:
- the orderData2 attribute of the order; null if the attribute not returned
getOrderData3
public java.lang.String getOrderData3()
- Returns the orderData3 attribute of the order.
-
- Returns:
- the orderData3 attribute of the order; null if the attribute not returned
getOrderData4
public byte[] getOrderData4()
- Returns the orderData4 attribute of the order.
-
- Returns:
- the orderData4 attribute of the order; null if the attribute not returned
getOrderData5
public byte[] getOrderData5()
- Returns the orderData5 attribute of the order.
-
- Returns:
- the orderData5 attribute of the order; null if the attribute not returned
getMerchantAccount
public java.lang.String getMerchantAccount()
- Returns the MerchantAccount attribute of the order.
-
- Returns:
- the merchantAccount attribute of the order; null if the attribute not returned
getApprovesAllowed
public java.lang.Boolean getApprovesAllowed()
- Returns the ApprovesAllowed attribute of the order.
-
- Returns:
- the approvesAllowed attribute of the order; null if the attribute not returned
getUnapprovedAmount
public java.lang.Integer getUnapprovedAmount()
- Returns the unapproved amount attribute of the order.
-
- Returns:
- the unapproveAmount attribute of the order; null if the attribute not returned
numberOfPayments
public int numberOfPayments()
- Returns the number of payments returned with this order. Note that this is the number of payments actually returned with the order, and not the number of payments associated with the order (i.e., if you perform a QueryOrders and do not specify WithPayments then this function will return 0).
-
- Returns:
- the number of payments returned with this order
- See Also:
- enumeratePayments()
enumeratePayments
public java.util.Enumeration enumeratePayments()
- Returns an enumeration of all payments returned with this order. Note that payments are only returned if you perform a QueryOrders and specify WithPayments.
-
- Returns:
- an enumeration of the payments returned with this order (all elements are PSPayment)
getPayment
public PSPayment getPayment(java.lang.String paymentNumber)
- Returns a particular payment associated with this order. Note that the payment will only be present if you perfomed a QueryOrders and specified WithPayments.
-
- Parameters:
- paymentNumber - the paymentNumber attribute of the desired payment
- Returns:
- the payment with this paymentNumber ; null if payment does not exist or was not returned with the order.
numberOfCredits
public int numberOfCredits()
- Returns the number of credits returned with this order. Note that this is the number of creditss actually returned with the order, and not the number of creditss associated with the order (i.e., if you perform a QueryOrders and do not specify WithCredits then this function will return 0).
-
- Returns:
- the number of credits returned with this order
- See Also:
- enumerateCredits()
enumerateCredits
public java.util.Enumeration enumerateCredits()
- Returns an enumeration of all credits returned with this order. Note that credits are only returned if you perform a QueryOrders and specify WithCredits.
-
- Returns:
- an enumeration of the credits returned with this order (all elements are PSCredi)
getCredit
public PSCredit getCredit(java.lang.String creditNumber)
- Returns a particular credit associated with this order. Note that the credit will only be present if you perfomed a QueryOrders and specified WithCredits.
-
- Parameters:
- creditNumber - the creditNumber attribute of the desired credit
- Returns:
- the credit with this creditNumber ; null if credit does not exist or was not returned with the order.
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.