org.osid.grading

Interface GradebookColumnList

All Superinterfaces:

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

public interface GradebookColumnList
extends OsidList

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

       
       
       while (gcl.hasNext()) {
            GradebookColumn column = gcl.getNextGradebookColumn();
       }
       
                   
       
  

or

       
       
       while (gcl.hasNext()) {
            GradebookColumn[] columns = gcl.getNextGradebookColumns(gcl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextGradebookColumn

GradebookColumn getNextGradebookColumn()
                                       throws OperationFailedException

Gets the next GradebookColumn in this list.

Returns:

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

getNextGradebookColumns

GradebookColumn[] getNextGradebookColumns(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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