com.ibm.etill.framework.clientapi
Class PSBatch
java.lang.Object
com.ibm.etill.framework.clientapi.PSObject
com.ibm.etill.framework.clientapi.PSBatch
- All Implemented Interfaces:
- XDMConstants
- public class PSBatch
- extends PSObject
The PSBatch class represents a Payment Server Batch object. The class includes accessor methods for retrieving individual attributes of the batch 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 |
PSBatch(Element xmlBatch)
Construct a PSBatch object. |
Method Summary |
java.util.Enumeration |
enumerateBatchTotals()
Returns an enumeration of batchTotals associated with the batch. |
java.util.Enumeration |
enumerateCredits()
Returns an enumeration of credits associated with the batch. |
java.util.Enumeration |
enumeratePayments()
Returns an enumeration of payments associated with the batch. |
java.lang.String |
getBatchNumber()
Returns the BatchNumber attribute of the batch. |
java.lang.String |
getBatchStatus()
Returns the BatchStatus attribute of the batch. |
PSBatchTotal |
getBatchTotal(java.lang.String currency, int amountExp10)
Returns the batchTotal object associated with the given currency and the amountExp10. |
PSCredit |
getCredit(java.lang.String orderNumber, java.lang.String creditNumber)
Returns the credit associated with the given order and the credit number. |
java.lang.Boolean |
getForceAllowed()
Returns whether the batch can be closed with the force option. |
java.lang.String |
getMerchantAccount()
Returns the MerchantAccount attribute of the batch. |
java.lang.Boolean |
getMerchantControl()
Returns the MerchantControl attribute of the batch. |
java.lang.String |
getMerchantNumber()
Returns the MerchantNumber attribute of the batch. |
PSPayment |
getPayment(java.lang.String orderNumber, java.lang.String paymentNumber)
Returns the payment associated with the given order and the payment number. |
java.lang.String |
getPaymentType()
Returns the PaymentType attribute of the batch. |
java.lang.Boolean |
getPurgeAllowed()
Returns whether the batch can be purged. |
java.lang.String |
getState()
Returns the CurrentState attribute of the batch. |
java.util.Date |
getTimeStampClosed()
Returns the TimeStampClosed attribute of the batch. |
java.util.Date |
getTimeStampOpened()
Returns the TimeStampOpened attribute of the batch. |
int |
numberOfBatchTotals()
Returns the number of batchTotals associated with the batch. |
int |
numberOfCredits()
Returns the number of credits associated with the batch. |
int |
numberOfPayments()
Returns the number of payments associated with the batch. |
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 |
batchTotalCollection
protected java.util.Hashtable batchTotalCollection
paymentCollection
protected java.util.Hashtable paymentCollection
creditCollection
protected java.util.Hashtable creditCollection
PSBatch
public PSBatch(Element xmlBatch)
- Construct a PSBatch object.
- Parameters:
- xmlBatch - -- a XML element of the Batch.
processCollection
protected static java.util.Hashtable processCollection(Element element)
- processCollection
getMerchantNumber
public java.lang.String getMerchantNumber()
- Returns the MerchantNumber attribute of the batch.
-
- Returns:
- the merchantNumber attribute of the batch
getMerchantAccount
public java.lang.String getMerchantAccount()
- Returns the MerchantAccount attribute of the batch.
-
- Returns:
- the merchantAccount attribute of the batch; null if the attribute not returned
getBatchNumber
public java.lang.String getBatchNumber()
- Returns the BatchNumber attribute of the batch.
-
- Returns:
- the BatchNumber attribute of the batch; null if the attribute not returned
getPaymentType
public java.lang.String getPaymentType()
- Returns the PaymentType attribute of the batch.
-
- Returns:
- the paymentType attribute of the batch; null if the attribute not returned
getMerchantControl
public java.lang.Boolean getMerchantControl()
- Returns the MerchantControl attribute of the batch.
-
- Returns:
- the MerchantControl attribute of the batch; null if the attribute not returned
getPurgeAllowed
public java.lang.Boolean getPurgeAllowed()
- Returns whether the batch can be purged.
-
- Returns:
- the PurgeAllowed attribute of the batch; null if the attribute not returned
getForceAllowed
public java.lang.Boolean getForceAllowed()
- Returns whether the batch can be closed with the force option.
-
- Returns:
- the ForceAllowed attribute of the batch; null if the attribute not returned
getTimeStampOpened
public java.util.Date getTimeStampOpened()
- Returns the TimeStampOpened attribute of the batch.
-
- Returns:
- the timeStampOpened attribute of the batch; null if the attribute not returned
getTimeStampClosed
public java.util.Date getTimeStampClosed()
- Returns the TimeStampClosed attribute of the batch.
-
- Returns:
- the timeStampClosed attribute of the batch; null if the attribute not returned
getState
public java.lang.String getState()
- Returns the CurrentState attribute of the batch.
-
- Returns:
- the currentState attribute of the batch; null if the attribute not returned
getBatchStatus
public java.lang.String getBatchStatus()
- Returns the BatchStatus attribute of the batch.
-
- Returns:
- the BatchStatus attribute of the batch; null if the attribute not returned
numberOfPayments
public int numberOfPayments()
- Returns the number of payments associated with the batch.
-
- Returns:
- the number of payments associated with the batch.
enumeratePayments
public java.util.Enumeration enumeratePayments()
- Returns an enumeration of payments associated with the batch.
-
- Returns:
- the enumeration of payments associated with the batch.
getPayment
public PSPayment getPayment(java.lang.String orderNumber,
java.lang.String paymentNumber)
- Returns the payment associated with the given order and the payment number.
-
- Parameters:
- orderNumber - -- order number
- paymentNumber - -- payment number
- Returns:
- the payment object associated with the given order and the payment number.
numberOfCredits
public int numberOfCredits()
- Returns the number of credits associated with the batch.
-
- Returns:
- the number of credits associated with the batch.
enumerateCredits
public java.util.Enumeration enumerateCredits()
- Returns an enumeration of credits associated with the batch.
-
- Returns:
- the enumeration of credits associated with the batch.
getCredit
public PSCredit getCredit(java.lang.String orderNumber,
java.lang.String creditNumber)
- Returns the credit associated with the given order and the credit number.
-
- Parameters:
- orderNumber - -- order number
- creditNumber - -- credit number
- Returns:
- the payment object associated with the given order and the credit number.
numberOfBatchTotals
public int numberOfBatchTotals()
- Returns the number of batchTotals associated with the batch.
-
- Returns:
- the number of batchTotals associated with the batch.
enumerateBatchTotals
public java.util.Enumeration enumerateBatchTotals()
- Returns an enumeration of batchTotals associated with the batch.
-
- Returns:
- the enumeration of batchTotals associated with the batch.
getBatchTotal
public PSBatchTotal getBatchTotal(java.lang.String currency,
int amountExp10)
- Returns the batchTotal object associated with the given currency and the amountExp10.
-
- Parameters:
- currency - -- the currency being used.
- amountExp10 - -- value of the amountExp10
- Returns:
- the batchTotal object associated with the given currency and the amountExp10.
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.