OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.AuditEnablerSmartInquestSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic inquests. An AuditEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of audit enablers. The audit enablers may be sequenced using the AuditEnablerSearchOrder from this session.

This Inquest has a default query that matches any audit enabler and a default search order that specifies no sequencing. The queries may be examined using an AuditEnablerQueryInspector. The query may be modified by converting the inspector back to an AuditEnablerQuery.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartInquests
Description

Tests if this user can manage smart inquests. 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 inquest management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerQuery
Description

Gets an audit enabler query.

Returnosid.inquiry.rules.AuditEnablerQuerythe audit enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerSearchOrder
Description

Gets an audit enabler search order.

Returnosid.inquiry.rules.AuditEnablerSearchOrderthe audit enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyAuditEnablerQuery
Description

Applies an audit enabler query to this inquest.

Parametersosid.inquiry.rules.AuditEnablerQueryauditEnablerQuerythe audit enabler query
ErrorsNULL_ARGUMENT auditEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auditEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAuditEnablerQuery
Description

Gets an audit enabler query inspector for this inquest.

Returnosid.inquiry.rules.AuditEnablerQueryInspectorthe audit enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAuditEnablerSequencing
Description

Applies an audit enabler search order to this inquest.

Parametersosid.inquiry.rules.AuditEnablerSearchOrderauditEnablerSearchOrderthe audit enabler search order
ErrorsNULL_ARGUMENT auditEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auditEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerQueryFromInspector
Description

Gets an audit enabler query from an inspector.

Parametersosid.inquiry.rules.AuditEnablerQueryInspectorauditEnablerQueryInspectoran audit enabler query inspector
Returnosid.inquiry.rules.AuditEnablerQuerythe audit enabler query
ErrorsNULL_ARGUMENT auditEnablerQueryInspector is null
UNSUPPORTED auditEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.