org.osid.hierarchy

Interface NodeList

All Superinterfaces:

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

public interface NodeList
extends OsidList

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

       
       
       while (nl.hasNext()) {
            Node node = nl.getNextNode();
       }
       
                   
       
  

or

       
       
       while (nl.hasNext()) {
            Node[] nodes = nl.getNextNodes(nl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextNode

Node getNextNode()
                 throws OperationFailedException

Gets the next Node in this list.

Returns:

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

getNextNodes

Node[] getNextNodes(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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