OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.InquestSearchSession
Implementsosid.inquiry.InquestQuerySession
Used Byosid.inquiry.InquiryManager
osid.inquiry.InquiryProxyManager
Description

This session provides methods for searching among Inquests. The search query is constructed using the InquestQuery.

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

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

MethodgetInquestSearch
Description

Gets an inquest search.

Returnosid.inquiry.InquestSearch the inquest search
Compliancemandatory This method must be implemented.
MethodgetInquestSearchOrder
Description

Gets an inquest search order. The InquestSearchOrder is supplied to an InquestSearch to specify the ordering of results.

Returnosid.inquiry.InquestSearchOrder the inquest search order
Compliancemandatory This method must be implemented.
MethodgetInquestsBySearch
Description

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

Parametersosid.inquiry.InquestQueryinquestQuery the inquest query
osid.inquiry.InquestSearchinquestSearch the inquest search
Returnosid.inquiry.InquestSearchResults the inquest search results
ErrorsNULL_ARGUMENT inquestQuery or inquestSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED inquestQuery or inquestSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetInquestQueryFromInspector
Description

Gets an inquest query from an inspector. The inspector is available from an InquestSearchResults.

Parametersosid.inquiry.InquestQueryInspectorinquestQueryInspector an inquest query inspector
Returnosid.inquiry.InquestQuery the inquest query
ErrorsNULL_ARGUMENT inquestQueryInspector is null
UNSUPPORTED inquestQueryInspector is not of this service
Compliancemandatory This method must be implemented.