org.osid.grading.transform

Interface GradeMapList

All Superinterfaces:

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

public interface GradeMapList
extends OsidList

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

       
       
       while (gml.hasNext()) {
            GradeMap map = gtsl.getNextGradeMap();
       }
       
                   
       
  

or

       
       
       while (gml.hasNext()) {
            GradeMap[] maps = gml.getNextGradeMaps(gml.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextGradeMap

GradeMap getNextGradeMap()
                         throws OperationFailedException

Gets the next GradeMap in this list.

Returns:

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

getNextGradeMaps

GradeMap[] getNextGradeMaps(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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