Interface CourseCatalogBatchFormList

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

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

while (ccbfl.hasNext()) {
     CourseCatalogBatchForm form = ccbfl.getNextCourseCatalogBatchForm();
}
or 
while (ccbfl.hasNext()) {
     CourseCatalogBatchForm[] forms = ccbfl.getNextCourseCatalogBatchForms(ccbfl.available());
}

  • Method Details

    • getNextCourseCatalogBatchForm

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

    • getNextCourseCatalogBatchForms

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