OSID Logo
OSID Specifications
logging package
Version 3.1.0
Interfaceosid.logging.LogQuerySession
Implementsosid.OsidSession
Implemented Byosid.logging.LogSearchSession
Used Byosid.logging.LoggingManager
osid.logging.LoggingProxyManager
Description

This session provides methods for searching Logs. 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
Compliancemandatory This method must be implemented.
MethodgetLogQuery
Description

Gets a log query.

Returnosid.logging.LogQuery the log query
Compliancemandatory This method must be implemented.
MethodgetLogsByQuery
Description

Gets a list of Logs matching the given log query.

Parametersosid.logging.LogQuerylogQuery the log query
Returnosid.logging.LogList the returned LogList
ErrorsNULL_ARGUMENT logQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED logQuery is not of this service
Compliancemandatory This method must be implemented.