OSID - osid.inquiry.ResponseQuerySession Service Interface Definition

Interface	osid.inquiry.ResponseQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Response` objects. The search query is constructed using the `ResponseQuery.` 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	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchResponses
Description	Tests if this user can perform `Response` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include responses in inquests which are children of this inquest in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
Compliance	`mandatory`		This method is must be implemented.
Method	getResponseQuery
Description	Gets a response query.
Return	`osid.inquiry.ResponseQuery`		the response query
Compliance	`mandatory`		This method must be implemented.
Method	getResponsesByQuery
Description	Gets a list of `Responses` matching the given response query.
Parameters	`osid.inquiry.ResponseQuery`	`responseQuery`	the response query
Return	`osid.inquiry.ResponseList`		the returned `ResponseList`
Errors	NULL_ARGUMENT		`responseQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`responseQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.