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

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

getInquiriesByQuery() is the basic search method and returns a list of Inquiries. A more advanced search may be performed with getInquiriesBySearch(). It accepts an InquirySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getInquiriesBySearch() returns an InquirySearchResults that can be used to access the resulting InquiryList or be used to perform a search within the result set through InquirySearch.

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 record indicated by their respective record types. The query record is accessed via the InquiryQuery.

MethodgetInquirySearch
Description

Gets an inquiry search.

Returnosid.inquiry.InquirySearchthe inquiry search
CompliancemandatoryThis method must be implemented.
MethodgetInquirySearchOrder
Description

Gets an inquiry search order. The InquirySearchOrder is supplied to an InquirySearch to specify the ordering of results.

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

Gets the search results matching the given search query using the given search.

Parametersosid.inquiry.InquiryQueryinquiryQuerythe inquiry query
osid.inquiry.InquirySearchinquirySearchthe inquiry search
Returnosid.inquiry.InquirySearchResultsthe inquiry search results
ErrorsNULL_ARGUMENT inquiryQuery or inquirySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquiryQuery or inquirySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquiryQueryFromInspector
Description

Gets an inquiry query from an inspector. The inspector is available from an InquirySearchResults.

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.