Interface CourseRegistrationPeerList

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

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

while (crpl.hasNext()) {
     CourseRegistrationPeer peer = crpl.getNextCourseRegistrationPeer();
}
or 
while (crpl.hasNext()) {
     CourseRegistrationPeer[] peers = crpl.getNextCourseRegistrationPeers(crpl.available());
}

  • Method Details

    • getNextCourseRegistrationPeer

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

    • getNextCourseRegistrationPeers

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