OSID Logo
OSID Specifications
billing payment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.batch.PaymentPeerList
Implementsosid.OsidList
Description

Like all OsidLists, PaymentPeerList provides a means for accessing PaymentPeer elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (ppl.hasNext()) {
                          PaymentPeer peer = pfl.getNextPaymentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppl.hasNext()) {
                          PaymentPeer[] peers = ppl.getNextPaymentPeer(ppl.available());
                     }
                     
                                 
                     
                
MethodgetNextPaymentPeer
Description

Gets the next PaymentPeer in this list.

Returnosid.billing.payment.batch.PaymentPeerthe next PaymentPeer in this list. The hasNext() method should be used to test that a next PaymentPeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPaymentPeers
Description

Gets the next set of PaymentPeer elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinalnthe number of PaymentPeer elements requested which must be less than or equal to available()
Returnosid.billing.payment.batch.PaymentPeer[]an array of PaymentPeer elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.