Interface JournalEntryBatchFormList

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

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

while (jebfl.hasNext()) {
     JournalEntryBatchForm form = jebfl.getNextJournalEntryBatchForm();
}
or 
while (jebfl.hasNext()) {
     JournalEntryBatchForm[] forms = jebfl.getNextJournalEntryBatchForms(jebfl.available());
}

  • Method Details

    • getNextJournalEntryBatchForm

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

    • getNextJournalEntryBatchForms

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