OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.InquiryQuerySession
Implementsosid.OsidSession
Implemented Byosid.inquiry.InquirySearchSession
Used Byosid.inquiry.InquiryManager
osid.inquiry.InquiryProxyManager
Description

This session provides methods for searching among Inquiries. 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.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.
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
Compliancemandatory This 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.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedInquestView
Description

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

Compliancemandatory This method is must be implemented.
MethodgetInquiryQuery
Description

Gets an inquiry query.

Returnosid.inquiry.InquiryQuery the inquiry query
Compliancemandatory This method must be implemented.
MethodgetInquiriesByQuery
Description

Gets a list of Inquiries matching the given inquiry query,

Parametersosid.inquiry.InquiryQueryinquiryQuery the inquiry query
Returnosid.inquiry.InquiryList the returned InquiryList
ErrorsNULL_ARGUMENT inquiryQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED inquiryQuery is not of this service
Compliancemandatory This method must be implemented.