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

This session manages queries and sequencing to create "smart" dynamic catalogs. Sn InquiryQuery can be retrieved from this session and inquestped to this Inquest to create a virtual collection of Inquiries. The inquiries may be sequenced using the InquirySearchOrder from this session.

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

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

Gets an inquiry query.

Returnosid.inquiry.InquiryQuerythe inquiry query
CompliancemandatoryThis method must be implemented.
MethodgetInquirySearchOrder
Description

Gets an inquiry search order.

Returnosid.inquiry.InquirySearchOrderthe inquiry search order
CompliancemandatoryThis method must be implemented.
MethodapplyInquiryQuery
Description

Applies an inquiry query to this inquest.

Parametersosid.inquiry.InquiryQueryinquiryQuerythe inquiry query
ErrorsNULL_ARGUMENT inquiryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inquiryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectInquiryQuery
Description

Gets an inquiry query inspector for this inquest.

Returnosid.inquiry.InquiryQueryInspectorthe inquiry query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyInquirySequencing
Description

Applies an inquiry search order to this inquest.

Parametersosid.inquiry.InquirySearchOrderinquirySearchOrderthe inquiry search order
ErrorsNULL_ARGUMENT inquirySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inquirySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquiryQueryFromInspector
Description

Gets an inquiry query from an inspector.

Parametersosid.inquiry.InquiryQueryInspectorinquiryQueryInspectoran inquiry query inspector
Returnosid.inquiry.InquiryQuerythe inquiry query
ErrorsNULL_ARGUMENT inquiryQueryInspector is null
UNSUPPORTED inquiryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.