OSID Logo
OSID Specifications
billing payment batch package
Version 3.1.0
Interfaceosid.billing.payment.batch.PayerBatchFormList
Implementsosid.OsidList
Used Byosid.billing.payment.batch.PayerBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     PayerBatchForm form = pbfl.getNextPayerBatchForm();
}
                
or
while (pbfl.hasNext()) {
     PayerBatchForm[] forms = pbfl.getNextPayerBatchForms(pbfl.available());
}
                
MethodgetNextPayerBatchForm
Description

Gets the next PayerBatchForm in this list.

Returnosid.billing.payment.batch.PayerBatchForm the next PayerBatchForm in this list. The hasNext() method should be used to test that a next PayerBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextPayerBatchForms
Description

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

Parameterscardinaln the number of PayerBatchForm elements requested which must be less than or equal to available()
Returnosid.billing.payment.batch.PayerBatchForm[] an array of PayerBatchForm elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.