Interface CourseEntryBatchFormList

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

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

while (cbfl.hasNext()) {
     CourseEntryBatchForm form = cbfl.getNextCourseEntryBatchForm();
}
or 
while (cbfl.hasNext()) {
     CourseEntryBatchForm[] forms = cbfl.getNextCourseEntryBatchForms(cbfl.available());
}

  • Method Details

    • getNextCourseEntryBatchForm

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

    • getNextCourseEntryBatchForms

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