OSID Logo
OSID Specifications
logging package
Version 3.1.0
Interfaceosid.logging.LogSearchResults
Implementsosid.OsidSearchResults
Used Byosid.logging.LogSearchSession
Description

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

MethodgetLogs
Description

Gets the log list resulting from a search.

Returnosid.logging.LogList the log list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetLogQueryInspector
Description

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

Returnosid.logging.LogQueryInspector the log query inspector
Compliancemandatory This 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.TypelogSearchRecordType a log search record type
Returnosid.logging.records.LogSearchResultsRecord the log search results record
ErrorsNULL_ARGUMENT logSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(logSearchRecordType) is false
Compliancemandatory This method must be implemented.