org.osid.metering

Interface ReadingList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface ReadingList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Reading	getNextReading() Gets the next Reading in this list.
Reading[]	getNextReadings(long n) Gets the next set of Reading elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextReading

Reading getNextReading()
                       throws OperationFailedException

Gets the next Reading in this list.

Returns:

the next Reading in this list. The hasNext() method should be used to test that a next Reading is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextReadings

Reading[] getNextReadings(long n)
                          throws OperationFailedException

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

Parameters:

n - the number of Reading elements requested which must be less than or equal to available()

Returns:

an array of Reading elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.