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

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

                     
                     
                     while (ml.hasNext()) {
                          Meter meter = ml.getNextMeter();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ml.hasNext()) {
                          Meter[] meters = ml.getNextMeters(ml.available());
                     }
                     
                                 
                     
                
MethodgetNextMeter
Description

Gets the next Meter in this list.

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

Gets the next set of Meters in this list which must be less than or equal to the return from available().

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