Interface JournalBatchFormList

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

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

while (jbfl.hasNext()) {
     JournalBatchForm form = jbfl.getNextJournalBatchForm();
}
or 
while (jbfl.hasNext()) {
     JournalBatchForm[] forms = jbfl.getNextJournalBatchForms(jbfl.available());
}

  • Method Details

    • getNextJournalBatchForm

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

    • getNextJournalBatchForms

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