org.osid.grading

Interface GradebookList

All Superinterfaces:

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

public interface GradebookList
extends OsidList

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

       
       
       while (gl.hasNext()) {
            Gradebook gradebook = gl.getNextGradebook();
       }
       
                   
       
  

or

       
       
       while (gl.hasNext()) {
            Gradebook[] gradebooks = gl.getNextGradebooks(gl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextGradebook

Gradebook getNextGradebook()
                           throws OperationFailedException

Gets the next Gradebook in this list.

Returns:

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

getNextGradebooks

Gradebook[] getNextGradebooks(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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