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()); }
Modifier and Type | Method and Description |
---|---|
JournalBatchForm |
getNextJournalBatchForm()
Gets the next
JournalBatchForm in this list. |
JournalBatchForm[] |
getNextJournalBatchForms(long n)
Gets the next set of
JournalBatchForm elements in this
list. |
JournalBatchForm getNextJournalBatchForm() throws OperationFailedException
JournalBatchForm
in this list. JournalBatchForm
in this list. The
hasNext()
method should be used to test that a
next JournalBatchForm
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. JournalBatchForm[] getNextJournalBatchForms(long n) throws OperationFailedException
JournalBatchForm
elements in this
list. The specified amount must be less than or equal to the return
from available().
n
- the number of JournalBatchForm
elements
requested which must be less than or equal to
available()
JournalBatchForm
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.