org.osid.learning

Interface ObjectiveNodeList

All Superinterfaces:

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

public interface ObjectiveNodeList
extends OsidList

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

       
       
       while (onl.hasNext()) {
            ObjectiveNode node = onl.getNextObjectiveNode();
       }
       
                   
       
  

or

       
       
       while (onl.hasNext()) {
            ObjectiveNode[] nodes = onl.getNextObjectiveNodes(onl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ObjectiveNode	getNextObjectiveNode() Gets the next ObjectiveNode in this list.
ObjectiveNode[]	getNextObjectiveNodes(long n) Gets the next set of ObjectiveNode elements in this list which must be less than or equal to the number returned from available().

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

getNextObjectiveNode

ObjectiveNode getNextObjectiveNode()
                                   throws OperationFailedException

Gets the next ObjectiveNode in this list.

Returns:

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

getNextObjectiveNodes

ObjectiveNode[] getNextObjectiveNodes(long n)
                                      throws OperationFailedException

Gets the next set of ObjectiveNode elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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