Interface AssessmentTakenPeerList

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

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

while (atpl.hasNext()) {
     AssessmentTakenPeer peer = atpl.getNextAssessmentTakenPeer();
}
or 
while (atpl.hasNext()) {
     AssessmentTakenPeer[] peers = atpl.getNextAssessmentTakenPeers(atpl.available());
}

  • Method Details

    • getNextAssessmentTakenPeer

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

    • getNextAssessmentTakenPeers

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