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

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

                     
                     
                     while (pl.hasNext()) {
                          Payment payment = pl.getNextPayment();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Payment[] payments = pl.getNextPayments(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPayment
Description

Gets the next Payment in this list.

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

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

Parameterscardinalnthe number of Payment elements requested which must be less than or equal to available()
Returnosid.billing.payment.Payment[]an array of Payment 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.