OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntrySearch
Implementsosid.OsidSearch
Description

The search interface for governing log entry searches.

MethodsearchAmongLogEntries
Description

Execute this search among the given list of log entries.

Parametersosid.id.IdListlogEntryIdslist of log entries
ErrorsNULL_ARGUMENT logEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderLogEntryResults
Description

Specify an ordering to the search results.

Parametersosid.logging.LogEntrySearchOrderlogEntrySearchOrderlog entry search order
ErrorsNULL_ARGUMENT logEntrySearchOrder is null
UNSUPPORTED logEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLogEntrySearchRecord
Description

Gets the log search 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.LogEntrySearchRecordthe log entry search record
ErrorsNULL_ARGUMENT logEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.