org.osid.metering

Interface UtilityNodeList

All Superinterfaces:

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

public interface UtilityNodeList
extends OsidList

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

       
       
       while (unl.hasNext()) {
            UtilityNode node = unl.getNextUtilityNode();
       }
       
                   
       
  

or

       
       
       while (unl.hasNext()) {
            UtilityNode[] nodes = unl.getNextUtilityNodes(unl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
UtilityNode	getNextUtilityNode() Gets the next UtilityNode in this list.
UtilityNode[]	getNextUtilityNodes(long n) Gets the next set of UtilityNode 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

getNextUtilityNode

UtilityNode getNextUtilityNode()
                               throws OperationFailedException

Gets the next UtilityNode in this list.

Returns:

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

getNextUtilityNodes

UtilityNode[] getNextUtilityNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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