OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntryList
Implementsosid.OsidList
Description

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

Gets the next JournalEntry in this list.

Returnosid.journaling.JournalEntrythe next JournalEntry in this list. The hasNext() method should be used to test that a next JournalEntry is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextJournalEntries
Description

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

Parameterscardinalnthe number of JournalEntry elements requested which must be less than or equal to available()
Returnosid.journaling.JournalEntry[]an array of JournalEntry elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.