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

Interface	osid.inquiry.rules.AuditEnablerSmartInquestSession
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 inquests. An `AuditEnablerQuery` can be retrieved from this session and mapped to this `Inquest` to create a virtual collection of audit enablers. The audit enablers may be sequenced using the `AuditEnablerSearchOrder` from this session. This `Inquest` has a default query that matches any audit enabler and a default search order that specifies no sequencing. The queries may be examined using an `AuditEnablerQueryInspector`. The query may be modified by converting the inspector back to an `AuditEnablerQuery`.
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	getAuditEnablerQuery
Description	Gets an audit enabler query.
Return	`osid.inquiry.rules.AuditEnablerQuery`		the audit enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablerSearchOrder
Description	Gets an audit enabler search order.
Return	`osid.inquiry.rules.AuditEnablerSearchOrder`		the audit enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditEnablerQuery
Description	Applies an audit enabler query to this inquest.
Parameters	`osid.inquiry.rules.AuditEnablerQuery`	`auditEnablerQuery`	the audit enabler query
Errors	NULL_ARGUMENT		`auditEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuditEnablerQuery
Description	Gets an audit enabler query inspector for this inquest.
Return	`osid.inquiry.rules.AuditEnablerQueryInspector`		the audit enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditEnablerSequencing
Description	Applies an audit enabler search order to this inquest.
Parameters	`osid.inquiry.rules.AuditEnablerSearchOrder`	`auditEnablerSearchOrder`	the audit enabler search order
Errors	NULL_ARGUMENT		`auditEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablerQueryFromInspector
Description	Gets an audit enabler query from an inspector.
Parameters	`osid.inquiry.rules.AuditEnablerQueryInspector`	`auditEnablerQueryInspector`	an audit enabler query inspector
Return	`osid.inquiry.rules.AuditEnablerQuery`		the audit enabler query
Errors	NULL_ARGUMENT		`auditEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`auditEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.