org.osid.mapping

Interface LocationNodeList

All Superinterfaces:

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

public interface LocationNodeList
extends OsidList

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

       
       
       while (lnl.hasNext()) {
            LocationNode locationNode = lnl.getNextLocationNode();
       }
       
                   
       
  

or

       
       
       while (lnl.hasNext()) {
            LocationNode[] locationNodes = lnl.getNextLocationNodes(lnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLocationNode

LocationNode getNextLocationNode()
                                 throws OperationFailedException

Gets the next LocationNode in this list.

Returns:

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

getNextLocationNodes

LocationNode[] getNextLocationNodes(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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