Interface GradeList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface GradeList
extends OsidList

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

while (gl.hasNext()) {
     Grade grade = gl.getNextGrade();
}            
  

or

while (gl.hasNext()) {
     Grade[] grades = gl.getNextGrades(gl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Grade	getNextGrade()	Gets the next Grade in this list.
Grade[]	getNextGrades(long n)	Gets the next set of Grade elements in this list which must be less than or equal to the return from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextGrade

Grade getNextGrade()
            throws OperationFailedException

Gets the next Grade in this list.

Returns:

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

getNextGrades

Grade[] getNextGrades(long n)
               throws OperationFailedException

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

Parameters:

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

Returns:

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