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