Interface LogEntryBatchFormList

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

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

while (lebfl.hasNext()) {
     LogEntryBatchForm form = lebfl.getNextLogEntryBatchForm();
}
or 
while (lebfl.hasNext()) {
     LogEntryBatchForm[] forms = lebfl.getNextLogEntryBatchForms(lebfl.available());
}

  • Method Details

    • getNextLogEntryBatchForm

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

    • getNextLogEntryBatchForms

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