Interface CourseRegistrationList

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

Like all OsidLists , CourseRegistratio nList provides a means for accessing CourseRegistr ation elements sequentially either one at a time or many at a time. Examples: 

while (crl.hasNext()) {
     CourseRegistration courseRegistration = crl.getNextCourseRegis
tration();

} 

or

while (crl.hasNext()) {
     CourseRegistration[] courseRegistrations = crl.getNextCourseRegistrations(crl.available());
}

  • Method Details

    • getNextCourseRegistration

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

    • getNextCourseRegistrations

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