OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntrySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetLogEntries
Description

Gets the log entry list resulting from a search.

Returnosid.logging.LogEntryListthe log entry list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.logging.LogEntryQueryInspectorthe log entry query inspector
CompliancemandatoryThis method must be implemented.
MethodgetLogEntrySearchResultsRecord
Description

Gets the log entry search results record corresponding to the given log entry search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypelogEntrySearchRecordTypea log entry search record type
Returnosid.logging.records.LogEntrySearchResultsRecordthe log entry search results record
ErrorsNULL_ARGUMENT logEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.