org.osid.metering

Interface MeterList

All Superinterfaces:

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

public interface MeterList
extends OsidList

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

Method Summary

Methods

Modifier and Type	Method and Description
Meter	getNextMeter() Gets the next Meter in this list.
Meter[]	getNextMeters(long n) Gets the next set of Meters in this list which must be less than or equal to the return from available().

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

getNextMeter

Meter getNextMeter()
                   throws OperationFailedException

Gets the next Meter in this list.

Returns:

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

getNextMeters

Meter[] getNextMeters(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

an array of Meter 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.