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

Interface	osid.inquiry.rules.AuditProcessorSmartInquestSession
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 `AuditProcessorQuery` can be retrieved from this session and mapped to this `Inquest` to create a virtual collection of `AuditProcessors`. The audit processors may be sequenced using the `AuditProcessorSearchOrder` from this session. This `Inquest` has a default query that matches any audit processor and a default search order that specifies no sequencing. The queries may be examined using an `AuditProcessorQueryInspector`. The query may be modified by converting the inspector back to an `AuditProcessorQuery`.
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	getAuditProcessorQuery
Description	Gets an audit processor query.
Return	`osid.inquiry.rules.AuditProcessorQuery`		the audit processor query
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorSearchOrder
Description	Gets an audit processor search order.
Return	`osid.inquiry.rules.AuditProcessorSearchOrder`		the audit processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditProcessorQuery
Description	Applies an audit processor query to this inquest.
Parameters	`osid.inquiry.rules.AuditProcessorQuery`	`auditProcessorQuery`	the audit processor query
Errors	NULL_ARGUMENT		`auditProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuditProcessorQuery
Description	Gets an audit processor query inspector for this inquest.
Return	`osid.inquiry.rules.AuditProcessorQueryInspector`		the audit processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuditProcessorSequencing
Description	Applies an audit processor search order to this inquest.
Parameters	`osid.inquiry.rules.AuditProcessorSearchOrder`	`auditProcessorSearchOrder`	the audit processor search order
Errors	NULL_ARGUMENT		`auditProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auditProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorQueryFromInspector
Description	Gets an audit processor query from an inspector.
Parameters	`osid.inquiry.rules.AuditProcessorQueryInspector`	`auditProcessorQueryInspector`	an audit processor query inspector
Return	`osid.inquiry.rules.AuditProcessorQuery`		the audit processor query
Errors	NULL_ARGUMENT		`auditProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`auditProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.