OSID Logo
OSID Specifications
billing batch package
Version 3.1.0
Interfaceosid.billing.batch.EntryBatchFormList
Implementsosid.OsidList
Used Byosid.billing.batch.EntryBatchAdminSession
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.EntryBatchForm the next EntryBatchForm in this list. The hasNext() method should be used to test that a next EntryBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.