OSID Logo
OSID Specifications
metering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.batch.UtilityBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ubfl.hasNext()) {
                          UtilityBatchForm form = ubfl.getNextUtilityBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ubfl.hasNext()) {
                          UtilityBatchForm[] forms = ubfl.getNextUtilityBatchForms(ubfl.available());
                     }
                     
                                 
                     
                
MethodgetNextUtilityBatchForm
Description

Gets the next UtilityBatchForm in this list.

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

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

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