OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditConstrainerEnablerSmartInquestSession
Implementsosid.OsidSession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditConstrainerEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of AuditConstrainerEnablers. The audit constrainer enablers may be sequenced using the AuditConstrainerEnablerSearchOrder from this session.

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

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Id the Inquest Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquest the inquest
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablerQuery
Description

Gets an audit constrainer enabler query.

Returnosid.inquiry.rules.AuditConstrainerEnablerQuery the audit constrainer enabler query
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablerSearchOrder
Description

Gets an audit constrainer enabler search order.

Returnosid.inquiry.rules.AuditEnablerSearchOrder the audit constrainer enabler search order
Compliancemandatory This method must be implemented.
MethodapplyAuditConstrainerEnablerQuery
Description

Applies an audit constrainer enabler query to this inquest.

Parametersosid.inquiry.rules.AuditConstrainerEnablerQueryauditConstrainerEnablerQuery the audit constrainer enabler query
ErrorsNULL_ARGUMENT auditConstrainerEnablerQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED auditConstrainerEnablerQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectAuditConstrainerEnablerQuery
Description

Gets an audit constrainer enabler query inspector for this inquest.

Returnosid.inquiry.rules.AuditConstrainerEnablerQueryInspector the audit constrainer enabler query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyAuditConstrainerEnablerSequencing
Description

Applies an audit constrainer enabler search order to this inquest.

Parametersosid.inquiry.rules.AuditConstrainerEnablerSearchOrderauditConstrainerEnablerSearchOrder the audit constrainer enabler search order
ErrorsNULL_ARGUMENT auditConstrainerEnablerSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED auditConstrainerEnablerSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablerQueryFromInspector
Description

Gets an audit constrainer enabler query from an inspector.

Parametersosid.inquiry.rules.AuditConstrainerEnablerQueryInspectorauditConstrainerEnablerQueryInspector an audit constrainer enabler query inspector
Returnosid.inquiry.rules.AuditConstrainerEnablerQuery the audit constrainer enabler query
ErrorsNULL_ARGUMENT auditConstrainerEnablerQueryInspector is null
UNSUPPORTED auditConstrainerEnablerQueryInspector is not of this service
Compliancemandatory This method must be implemented.