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

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

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

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.
MethodgetInquiryEnablerQuery
Description

Gets an inquiry enabler query.

Returnosid.inquiry.rules.InquiryEnablerQuerythe inquiry enabler query
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerSearchOrder
Description

Gets an inquiry enabler search order.

Returnosid.inquiry.rules.InquiryEnablerSearchOrderthe inquiry enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyInquiryEnablerQuery
Description

Applies an inquiry enabler query to this inquest.

Parametersosid.inquiry.rules.InquiryEnablerQueryinquiryEnablerQuerythe inquiry enabler query
ErrorsNULL_ARGUMENT inquiryEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inquiryEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectInquiryEnablerQuery
Description

Gets an inquiry enabler query inspector for this inquest.

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

Applies an inquiry enabler search order to this inquest.

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

Gets an inquiry enabler query from an inspector.

Parametersosid.inquiry.rules.InquiryEnablerQueryInspectorinquiryEnablerQueryInspectoran inquiry enabler query inspector
Returnosid.inquiry.rules.InquiryEnablerQuerythe inquiry enabler query
ErrorsNULL_ARGUMENT inquiryEnablerQueryInspector is null
UNSUPPORTED inquiryEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.