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

Interface	osid.inquiry.rules.AuditProcessorEnablerSmartInquestSession
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 `AuditProcessorEnablerQuery` can be retrieved from this session and mapped to this `Inquest` to create a virtual collection of `AuditProcessorEnablers`. The audit processor enablers may be sequenced using the `AuditProcessorEnablerSearchOrder` from this session. This `Inquest` has a default query that matches any audit processor enabler and a default search order that specifies no sequencing. The queries may be examined using an `AuditProcessorEnablerQueryInspector`. The query may be modified by converting the inspector back to an `AuditProcessorEnablerQuery`.
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	getAuditProcessorEnablerQuery
Description	Gets an audit processor enabler query.
Return	`osid.inquiry.rules.AuditProcessorEnablerQuery`		the audit processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorEnablerSearchOrder
Description	Gets an audit processor enabler search order.
Return	`osid.inquiry.rules.AuditProcessorEnablerSearchOrder`		the audit processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditProcessorEnablerQuery
Description	Applies an audit processor enabler query to this inquest.
Parameters	`osid.inquiry.rules.AuditProcessorEnablerQuery`	`auditProcessorEnablerQuery`	the audit processot enabler query
Errors	NULL_ARGUMENT		`auditProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuditProcessorEnablerQuery
Description	Gets an audit processor enabler query inspector for this inquest.
Return	`osid.inquiry.rules.AuditProcessorEnablerQueryInspector`		the audit processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditProcessorEnablerSequencing
Description	Applies an audit processor enabler search order to this inquest.
Parameters	`osid.inquiry.rules.AuditProcessorEnablerSearchOrder`	`auditProcessorEnablerSearchOrder`	the audit processor enabler search order
Errors	NULL_ARGUMENT		`auditProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorEnablerQueryFromInspector
Description	Gets an audit processor enabler query from an inspector.
Parameters	`osid.inquiry.rules.AuditProcessorEnablerQueryInspector`	`auditProcessorEnablerQueryInspector`	an audit processor enabler query inspector
Return	`osid.inquiry.rules.AuditProcessorEnablerQuery`		the audit processor enabler query
Errors	NULL_ARGUMENT		`auditProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`auditProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.