Interface GradeEntryPeerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface GradeEntryPeerList extends OsidList

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

while (gepl.hasNext()) {
     GradeEntryPeer peer = gepl.getNextGradeEntryPeer();
}
or 
while (gepl.hasNext()) {
     GradeEntryPeer[] peers = gepl.getNextGradeEntryPeers(gepl.available());
}

Like all OsidLists, GradeEntryPeerList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextGradeEntryPeer

      GradeEntryPeer getNextGradeEntryPeer() throws OperationFailedException
      Gets the next GradeEntryPeer in this list.
      Returns:
      the next GradeEntryPeer in this list. The hasNext() method should be used to test that a next GradeEntryPeer 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.

    • getNextGradeEntryPeers

      GradeEntryPeer[] getNextGradeEntryPeers(long n) throws OperationFailedException
      Gets the next set of GradeEntryPeer elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of GradeEntryPeer elements requested which must be less than or equal to available()
      Returns:
      an array of GradeEntryPeer 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.