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

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

                     
                     
                     while (ebfl.hasNext()) {
                          EntryBatchForm form = ebfl.getNextEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          EntryBatchForm[] forms = ebfl.getNextEntryBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextEntryBatchForm
Description

Gets the next EntryBatchForm in this list.

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

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

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