OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.ResponseSearchSession
Implementsosid.inquiry.ResponseQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetResponseSearch
Description

Gets a response search.

Returnosid.inquiry.ResponseSearchthe response search
CompliancemandatoryThis method must be implemented.
MethodgetResponseSearchOrder
Description

Gets a response search order. The ResponseSearchOrder is supplied to a ResponseSearch to specify the ordering of results.

Returnosid.inquiry.ResponseSearchOrderthe response search order
CompliancemandatoryThis method must be implemented.
MethodgetResponsesBySearch
Description

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

Parametersosid.inquiry.ResponseQueryresponseQuerythe response query
osid.inquiry.ResponseSearchresponseSearchthe response search
Returnosid.inquiry.ResponseSearchResultsthe returned search results
ErrorsNULL_ARGUMENT responseQuery or responseSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED responseQuery or responseSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResponseQueryFromInspector
Description

Gets a response query from an inspector. The inspector is available from a ResponseSearchResults.

Parametersosid.inquiry.ResponseQueryInspectorresponseQueryInspectora response query inspector
Returnosid.inquiry.ResponseQuerythe response query
ErrorsNULL_ARGUMENT responseQueryInspector is null
UNSUPPORTED responseQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.