OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntryList
Implementsosid.OsidList
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.LogEntrythe next LogEntry in this list. The hasNext() method should be used to test that a next LogEntry is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.