OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Log objects. The search query is constructed using the LogQuery. The log record Type also specifies the record for the log query.

Logs may have a query record indicated by their respective record types. The query record is accessed via the LogQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchLogs
Description

Tests if this user can perform Log searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLogQuery
Description

Gets a log query.

Returnosid.logging.LogQuerythe log query
CompliancemandatoryThis method must be implemented.
MethodgetLogsByQuery
Description

Gets a list of Logs matching the given log query.

Parametersosid.logging.LogQuerylogQuerythe log query
Returnosid.logging.LogListthe returned LogList
ErrorsNULL_ARGUMENT logQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED logQuery is not of this service
CompliancemandatoryThis method must be implemented.