public interface JournalEntryList extends OsidList
Like all OsidLists,
JournalEntryList
provides a means for accessing JournalEntry
elements
sequentially either one at a time or many at a time. Examples:
while (jel.hasNext()) { JournalEntry entry = jel.getNextJournalEntry(); }or
while (jel.hasNext()) { JournalEntry[] entries = jel.getNextJournalEntries(jel.available()); }
Modifier and Type | Method and Description |
---|---|
JournalEntry[] |
getNextJournalEntries(long n)
Gets the next set of
JournalEntry elements in this
list. |
JournalEntry |
getNextJournalEntry()
Gets the next
JournalEntry in this list. |
JournalEntry getNextJournalEntry() throws OperationFailedException
JournalEntry
in this list. JournalEntry
in this list. The
hasNext()
method should be used to test that a next
JournalEntry
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. JournalEntry[] getNextJournalEntries(long n) throws OperationFailedException
JournalEntry
elements in this
list. The specified amount must be less than or equal to the return
from available().
n
- the number of JournalEntry
elements requested
which must be less than or equal to available()
JournalEntry
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.