org.osid.grading

Interface GradeSystemList

All Superinterfaces:

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

public interface GradeSystemList
extends OsidList

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

       
       
       while (gsl.hasNext()) {
            GradeSystem system = gsl.getNextGradeSystem();
       }
       
                   
       
  

or

       
       
       while (gsl.hasNext()) {
            GradeSystem[] systems = gsl.getNextGradeSystems(gsl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextGradeSystem

GradeSystem getNextGradeSystem()
                               throws OperationFailedException

Gets the next GradeSystem in this list.

Returns:

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

getNextGradeSystems

GradeSystem[] getNextGradeSystems(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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