org.osid.course

Interface TermNodeList

All Superinterfaces:

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

public interface TermNodeList
extends OsidList

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

       
       
       while (tnl.hasNext()) {
            TermNode node = tnl.getNextTermNode();
       }
       
                   
       
  

or

       
       
       while (tnl.hasNext()) {
            TermNode[] nodes = tnl.getNextTermNodes(tnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextTermNode

TermNode getNextTermNode()
                         throws OperationFailedException

Gets the next TermNode in this list.

Returns:

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

getNextTermNodes

TermNode[] getNextTermNodes(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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