org.osid.grading

Interface GradebookNodeList

All Superinterfaces:

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

public interface GradebookNodeList
extends OsidList

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

       
       
       while (gnl.hasNext()) {
            GradebookNode node = gnl.getNextGradebookNode();
       }
       
                   
       
  

or

       
       
       while (gnl.hasNext()) {
            GradebookNode[] nodes = gnl.getNextGradebookNodes(gnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
GradebookNode	getNextGradebookNode() Gets the next GradebookNode in this list.
GradebookNode[]	getNextGradebookNodes(long n) Gets the next set of GradebookNode elements in this list which must be less than or equal to the return 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

getNextGradebookNode

GradebookNode getNextGradebookNode()
                                   throws OperationFailedException

Gets the next GradebookNode in this list.

Returns:

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

getNextGradebookNodes

GradebookNode[] getNextGradebookNodes(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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