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

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

                     
                     
                     while (pl.hasNext()) {
                          Payer payer = pl.getNextPayer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Payer[] payers = pl.getNextPayers(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPayer
Description

Gets the next Payer in this list.

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

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

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