OSID - osid.inquiry.rules.AuditConstrainerSmartInquestSession Service Interface Definition

Interface	osid.inquiry.rules.AuditConstrainerSmartInquestSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AuditConstrainerQuery` can be retrieved from this session and mapped to this `Inquest` to create a virtual collection of `AuditConstrainers`. The audit constrainers may be sequenced using the `AuditConstrainerSearchOrder` from this session. This `Inquest` has a default query that matches any audit constrainer and a default search order that specifies no sequencing. The queries may be examined using an `AuditConstrainerQueryInspector`. The query may be modified by converting the inspector back to an `AuditConstrainerQuery`.
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	getAuditConstrainerQuery
Description	Gets an audit constrainer query.
Return	`osid.inquiry.rules.AuditConstrainerQuery`		the audit constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getAuditConstrainerSearchOrder
Description	Gets an audit constrainer search order.
Return	`osid.inquiry.rules.AuditConstrainerSearchOrder`		the audit constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditConstrainerQuery
Description	Applies an audit constrainer query to this inquest.
Parameters	`osid.inquiry.rules.AuditConstrainerQuery`	`auditConstrainerQuery`	the audit constrainer query
Errors	NULL_ARGUMENT		`auditConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuditConstrainerQuery
Description	Gets an audit constrainer query inspector for this inquest.
Return	`osid.inquiry.rules.AuditConstrainerQueryInspector`		the audit constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditConstrainerSequencing
Description	Applies an audit constrainer search order to this inquest.
Parameters	`osid.inquiry.rules.AuditConstrainerSearchOrder`	`auditConstrainerSearchOrder`	the audit constrainer search order
Errors	NULL_ARGUMENT		`auditConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuditConstrainerQueryFromInspector
Description	Gets an audit constrainer query from an inspector.
Parameters	`osid.inquiry.rules.AuditConstrainerQueryInspector`	`auditConstrainerQueryInspector`	an audit constrainer query inspector
Return	`osid.inquiry.rules.AuditConstrainerQuery`		the audit constrainer query
Errors	NULL_ARGUMENT		`auditConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`auditConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.