Interface GradeMapList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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

    Modifier and Type
    Method
    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 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

    • 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.