OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestSearchSession
Implementsosid.inquiry.InquestQuerySession
Description

This session provides methods for searching among Inquest objects. 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.InquestSearchthe inquest search
CompliancemandatoryThis 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.InquestSearchOrderthe inquest search order
CompliancemandatoryThis method must be implemented.
MethodgetInquestsBySearch
Description

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

Parametersosid.inquiry.InquestQueryinquestQuerythe inquest query
osid.inquiry.InquestSearchinquestSearchthe inquest search
Returnosid.inquiry.InquestSearchResultsthe inquest search results
ErrorsNULL_ARGUMENT inquestQuery or inquestSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquestQuery or inquestSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquestQueryFromInspector
Description

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

Parametersosid.inquiry.InquestQueryInspectorinquestQueryInspectoran inquest query inspector
Returnosid.inquiry.InquestQuerythe inquest query
ErrorsNULL_ARGUMENT inquestQueryInspector is null
UNSUPPORTED inquestQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.