OSID - osid.inquiry.ResponseSmartInquestSession Service Interface Definition

Interface	osid.inquiry.ResponseSmartInquestSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ResponseQuery` can be retrieved from this session and inquestped to this `Inquest` to create a virtual collection of `Responses`. The responses may be sequenced using the `ResponseSearchOrder` from this session. This `Inquest` has a default query that matches any response and a default search order that specifies no sequencing. The queries may be examined using a `ResponseQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartInquests
Description	Tests if this user can manage smart inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart inquest management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getResponseSearchOrder
Description	Gets a response search order.
Return	`osid.inquiry.ResponseSearchOrder`		the response search order
Compliance	`mandatory`		This method must be implemented.
Method	applyResponseQuery
Description	Applies a response query to this inquest.
Parameters	`osid.inquiry.ResponseQuery`	`responseQuery`	the response query
Errors	NULL_ARGUMENT		`responseQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`responseQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectResponseQuery
Description	Gets a response query inspector for this inquest.
Return	`osid.inquiry.ResponseQueryInspector`		the response query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyResponseSequencing
Description	Applies a response search order to this inquest.
Parameters	`osid.inquiry.ResponseSearchOrder`	`responseSearchOrder`	the response search order
Errors	NULL_ARGUMENT		`responseSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`responseSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResponseQueryFromInspector
Description	Gets a response query from an inspector.
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.