OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.ReadingList
Implementsosid.OsidList
Used Byosid.metering.MeterReadingSession
Description

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

while (rl.hasNext()) {
     Reading reading = rl.getNextReading();
}
                
or
while (rl.hasNext()) {
     Reading[] readings = rl.getNextReadings(rl.available());
}
                
MethodgetNextReading
Description

Gets the next Reading in this list.

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

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

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