Interface EnrollmentPeerList

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

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

while (epl.hasNext()) {
     EnrollmentPeer peer = epl.getNextEnrollmentPeer();
}
or 
while (epl.hasNext()) {
     EnrollmentPeer[] peers = epl.getNextEnrollmentPeers(epl.available());
}

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

  • Method Details

    • getNextEnrollmentPeer

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

    • getNextEnrollmentPeers

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