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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PeriodBatchForm form = pbfl.getNextPeriodBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PeriodBatchForm[] forms = pbfl.getNextPeriodBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPeriodBatchForm
Description

Gets the next PeriodBatchForm in this list.

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

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

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