OSID - osid.inquiry.ResponseSearchSession Service Interface Definition

Interface	osid.inquiry.ResponseSearchSession
Implements	`osid.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.`
Method	getResponseSearch
Description	Gets a response search.
Return	`osid.inquiry.ResponseSearch`		the response search
Compliance	`mandatory`		This method must be implemented.
Method	getResponseSearchOrder
Description	Gets a response search order. The `ResponseSearchOrder` is supplied to a `ResponseSearch` to specify the ordering of results.
Return	`osid.inquiry.ResponseSearchOrder`		the response search order
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inquiry.ResponseQuery`	`responseQuery`	the response query
Parameters	`osid.inquiry.ResponseSearch`	`responseSearch`	the response search
Return	`osid.inquiry.ResponseSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`responseQuery` or `responseSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`responseQuery` or `responseSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResponseQueryFromInspector
Description	Gets a response query from an inspector. The inspector is available from a `ResponseSearchResults.`
Parameters	`osid.inquiry.ResponseQueryInspector`	`responseQueryInspector`	a response query inspector
Return	`osid.inquiry.ResponseQuery`		the response query
Errors	NULL_ARGUMENT		`responseQueryInspector` is `null`
Errors	UNSUPPORTED		`responseQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.