OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalList
Implementsosid.OsidList
Used Byosid.journaling.JournalHierarchySession
osid.journaling.JournalLookupSession
osid.journaling.JournalQuerySession
osid.journaling.JournalSearchResults
Description

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());
}
                
MethodgetNextJournal
Description

Gets the next Journal in this list.

Returnosid.journaling.Journal the next Journal in this list. The hasNext() method should be used to test that a next Journal is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextJournals
Description

Gets the next set of Journal elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Journal elements requested which must be less than or equal to available()
Returnosid.journaling.Journal[] an array of Journal elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.