OSID - osid.inquiry.InquirySmartInquestSession Service Interface Definition

Interface	osid.inquiry.InquirySmartInquestSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. Sn `InquiryQuery` can be retrieved from this session and inquestped to this `Inquest` to create a virtual collection of `Inquiries.` The inquiries may be sequenced using the `InquirySearchOrder` from this session. This `Inquest` has a default query that matches any inquiry and a default search order that specifies no sequencing. The queries may be examined using an `InquiryQueryInspector.` The query may be modified by converting the inspector back to an `InquiryQuery.`
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	getInquiryQuery
Description	Gets an inquiry query.
Return	`osid.inquiry.InquiryQuery`		the inquiry query
Compliance	`mandatory`		This method must be implemented.
Method	getInquirySearchOrder
Description	Gets an inquiry search order.
Return	`osid.inquiry.InquirySearchOrder`		the inquiry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyInquiryQuery
Description	Applies an inquiry query to this inquest.
Parameters	`osid.inquiry.InquiryQuery`	`inquiryQuery`	the inquiry query
Errors	NULL_ARGUMENT		`inquiryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inquiryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectInquiryQuery
Description	Gets an inquiry query inspector for this inquest.
Return	`osid.inquiry.InquiryQueryInspector`		the inquiry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyInquirySequencing
Description	Applies an inquiry search order to this inquest.
Parameters	`osid.inquiry.InquirySearchOrder`	`inquirySearchOrder`	the inquiry search order
Errors	NULL_ARGUMENT		`inquirySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inquirySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryQueryFromInspector
Description	Gets an inquiry query from an inspector.
Parameters	`osid.inquiry.InquiryQueryInspector`	`inquiryQueryInspector`	an inquiry query inspector
Return	`osid.inquiry.InquiryQuery`		the inquiry query
Errors	NULL_ARGUMENT		`inquiryQueryInspector` is `null`
Errors	UNSUPPORTED		`inquiryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.