org.osid.mapping

Interface MapNodeList

All Superinterfaces:

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

public interface MapNodeList
extends OsidList

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

       
       
       while (mnl.hasNext()) {
            MapNode node = mnl.getNextMapNode(Node);
       }
       
                   
       
  

or

       
       
       while (mnl.hasNext()) {
            MapNode[] nodes = ml.getNextMapNodes(mnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextMapNode

MapNode getNextMapNode()
                       throws OperationFailedException

Gets the next MapNode in this list.

Returns:

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

getNextMapNodes

MapNode[] getNextMapNodes(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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