OSID Logo
OSID Specifications
logging package
Version 3.1.0
Interfaceosid.logging.LogEntryList
Implementsosid.OsidList
Used Byosid.logging.LogEntryLogSession
osid.logging.LogEntryLookupSession
osid.logging.LogEntryQuerySession
osid.logging.LogEntrySearchResults
Description

Like all OsidLists, LogList provides a means for accessing LogEntry elements sequentially either one at a time or many at a time. Examples:

while (lel.hasNext()) {
     LogEntry entry = lel.getNextLogEntry();
}
                
or
while (lel.hasNext()) {
     LogEntry[] entries = lel.getNextLogEntries(lel.available());
}
                
MethodgetNextLogEntry
Description

Gets the next LogEntry in this list.

Returnosid.logging.LogEntry the next LogEntry in this list. The hasNext() method should be used to test that a next LogEntry 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.
MethodgetNextLogEntries
Description

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

Parameterscardinaln the number of LogEntry elements requested which must be less than or equal to available()
Returnosid.logging.LogEntry[] an array of LogEntry 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.