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

This session provides methods for searching among Inquiry objects. The search query is constructed using the InquiryQuery.

This session defines views that offer differing behaviors for searching.

  • federated inquest view: searches include inquiries in inquests of which this inquest is an ancestor in the inquest hierarchy
  • isolated inquest view: searches are restricted to inquiries in this inquest

Inquiries may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchInquiries
Description

Tests if this user can perform Inquiry lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedInquestView
Description

Federates the view for methods in this session. A federated view will include inquiries in inquests which are children of this inquest in the inquest hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedInquestView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this inquest only.

CompliancemandatoryThis method is must be implemented.
MethodgetInquiryQuery
Description

Gets an inquiry query.

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

Gets a list of Inquiries matching the given inquiry query,

Parametersosid.inquiry.InquiryQueryinquiryQuerythe inquiry query
Returnosid.inquiry.InquiryListthe returned InquiryList
ErrorsNULL_ARGUMENT inquiryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquiryQuery is not of this service
CompliancemandatoryThis method must be implemented.