OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerSearchSession
Implementsosid.inquiry.rules.InquiryEnablerQuerySession
Description

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

getInquiryEnablersByQuery() is the basic search method and returns a list of InquiryEnablers. A more advanced search may be performed with getInquiryEnablersBySearch(). It accepts an InquiryEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as inquiry. getInquiryEnablersBySearch() returns an InquiryEnablerSearchResults that can be used to access the resulting InquiryEnablerList or be used to perform a search within the result set through InquiryEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

InquiryEnablers may have a query record indicated by their respective record types. The query record is accessed via the InquiryEnablerQuery.

MethodgetInquiryEnablerSearch
Description

Gets an inquiry enabler search.

Returnosid.inquiry.rules.InquiryEnablerSearchthe inquiry enabler search
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerSearchOrder
Description

Gets an inquiry enabler search order. The InquiryEnablerSearchOrder is supplied to an InquiryEnablerSearch to specify the ordering of results.

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

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

Parametersosid.inquiry.rules.InquiryEnablerQueryinquiryEnablerQuerythe inquiry enabler query
osid.inquiry.rules.InquiryEnablerSearchinquiryEnablerSearchthe inquiry enabler search
Returnosid.inquiry.rules.InquiryEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT inquiryEnablerQuery or inquiryEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquiryEnablerQuery or inquiryEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerQueryFromInspector
Description

Gets an inquiry enabler query from an inspector. The inspector is available from an InquiryEnablerSearchResults.

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.