OSID Logo
OSID Specifications
logging package
Version 3.1.0
Interfaceosid.logging.LogSearch
Implementsosid.OsidSearch
Used Byosid.logging.LogSearchSession
Description

The search interface for governing log searches.

MethodsearchAmongLogs
Description

Execute this search among the given list of logs.

Parametersosid.id.IdListlogIds list of logs
ErrorsNULL_ARGUMENT logIds is null
Compliancemandatory This method must be implemented.
MethodorderLogResults
Description

Specify an ordering to the search results.

Parametersosid.logging.LogSearchOrderlogSearchOrder log search order
ErrorsNULL_ARGUMENT logSearchOrder is null
UNSUPPORTED logSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetLogSearchRecord
Description

Gets the log search 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.LogSearchRecord the log search record
ErrorsNULL_ARGUMENT logSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(logSearchRecordType) is false
Compliancemandatory This method must be implemented.