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

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

MethodgetLogs
Description

Gets the log list resulting from a search.

Returnosid.logging.LogListthe log list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetLogQueryInspector
Description

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

Returnosid.logging.LogQueryInspectorthe log query inspector
CompliancemandatoryThis method must be implemented.
MethodgetLogSearchResultsRecord
Description

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

Parametersosid.type.TypelogSearchRecordTypea log search record type
Returnosid.logging.records.LogSearchResultsRecordthe log search results record
ErrorsNULL_ARGUMENT logSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logSearchRecordType) is false
CompliancemandatoryThis method must be implemented.