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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PaymentBatchForm form = pbfl.getNextPaymentBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PaymentBatchForm[] forms = pbfl.getNextPaymentBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPaymentBatchForm
Description

Gets the next PaymentBatchForm in this list.

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

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

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