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

This session manages queries and sequencing to create "smart" dynamic catalogs. A LogEntryQuery can be retrieved from this session and mapped to this Log to create a virtual collection of log entries. The log entries may be sequenced using the LogEntrySearchOrder from this session.

This Log has a default query that matches any log entry and a default search order that specifies no sequencing. The queries may be examined using a LogEntryQueryInspector. The query may be modified by converting the inspector back to a LogEntryQuery.

MethodgetLogId
Description

Gets the Log Id associated with this session.

Returnosid.id.Idthe Log Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetLog
Description

Gets the Log associated with this session.

Returnosid.logging.Logthe Log associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartLog
Description

Tests if this user can manage smart log. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart log management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryQuery
Description

Gets a logEntry query.

Returnosid.logging.LogEntryQuerythe log entry query
CompliancemandatoryThis method must be implemented.
MethodgetLogEntrySearchOrder
Description

Gets a logEntry search order.

Returnosid.logging.LogEntrySearchOrderthe logEntry search order
CompliancemandatoryThis method must be implemented.
MethodapplyLogEntryQuery
Description

Applies a logEntry query to this log.

Parametersosid.logging.LogEntryQuerylogEntryQuerythe logEntry query
ErrorsNULL_ARGUMENT logEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED logEntryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectLogEntryQuery
Description

Gets a logEntry query inspector for this log.

Returnosid.logging.LogEntryQueryInspectorthe logEntry query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyLogEntrySequencing
Description

Applies a logEntry search order to this log.

Parametersosid.logging.LogEntrySearchOrderlogEntrySearchOrderthe logEntry search order
ErrorsNULL_ARGUMENT logEntrySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED logEntrySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryQueryFromInspector
Description

Gets a logEntry query from an inspector.

Parametersosid.logging.LogEntryQueryInspectorlogEntryQueryInspectora resorce relationship query inspector
Returnosid.logging.LogEntryQuerythe logEntry query
ErrorsNULL_ARGUMENT logEntryQueryInspector is null
UNSUPPORTED logEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.