Interface CourseOfferingList

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

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

while (col.hasNext()) {
     CourseOffering offering = col.getNextCourseOffering();
}
or 
while (col.hasNext()) {
     CourseOffering[] offerings = col.getNextCourseOfferings(col.available());
}

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

  • Method Details

    • getNextCourseOffering

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

    • getNextCourseOfferings

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