Interface ModuleBatchFormList

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

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

while (mbfl.hasNext()) {
     ModuleBatchForm form = mbfl.getNextModuleBatchForm();
}
or 
while (mbfl.hasNext()) {
     ModuleBatchForm[] forms = mbfl.getNextModuleBatchForms(mbfl.available());
}

  • Method Details

    • getNextModuleBatchForm

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

    • getNextModuleBatchForms

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