OSID Logo
OSID Specifications
metering batch package
Version 3.1.0
Interfaceosid.metering.batch.MeterBatchFormList
Implementsosid.OsidList
Used Byosid.metering.batch.MeterBatchAdminSession
Description

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

while (mbfl.hasNext()) {
     MeterBatchForm form = mbfl.getNextMeterBatchForm();
}
                
or
while (mbfl.hasNext()) {
     MeterBatchForm[] forms = mbfl.getNextMeterBatchForms(mbfl.available());
}
                
MethodgetNextMeterBatchForm
Description

Gets the next MeterBatchForm in this list.

Returnosid.metering.batch.MeterBatchForm the next MeterBatchForm in this list. The hasNext() method should be used to test that a next MeterBatchForm 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.
MethodgetNextMeterBatchForms
Description

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

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