org.osid.grading

Interface GradeEntryList

All Superinterfaces:

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

public interface GradeEntryList
extends OsidList

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

       
       
       while (gel.hasNext()) {
            GradeEntry entry = gel.getNextGradeEntry();
       }
       
                   
       
  

or

       
       
       while (gel.hasNext()) {
            GradeEntry[] entries = gel.getNextGradeEntries(gel.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
GradeEntry[]	getNextGradeEntries(long n) Gets the next set of GradeEntry elements in this list which must be less than or equal to the number returned from available().
GradeEntry	getNextGradeEntry() Gets the next GradeEntry in this list.

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

getNextGradeEntry

GradeEntry getNextGradeEntry()
                             throws OperationFailedException

Gets the next GradeEntry in this list.

Returns:

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

getNextGradeEntries

GradeEntry[] getNextGradeEntries(long n)
                                 throws OperationFailedException

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

Parameters:

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

Returns:

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