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

Interface	osid.inquiry.rules.AuditProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.inquiry.rules.AuditProcessorSearchSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session provides methods for searching among `AuditProcessor` objects. The search query is constructed using the `AuditProcessorQuery`. This session defines views that offer differing behaviors for searching. federated inquest view: searches include audit processors in inquests of which this inquest is an ancestor in the inquest hierarchy isolated inquest view: searches are restricted to audit processors in this inquest Audit processors may have a query record indicated by their respective record types. The query record is accessed via the `AuditQuery`.
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	canSearchAuditProcessors
Description	Tests if this user can perform `AuditProcessor` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include audit processors in inquests which are children of this inquest in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this inquest only.
Compliance	`mandatory`		This method is 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	getAuditProcessorsByQuery
Description	Gets a list of `AuditProcessors` matching the given search.
Parameters	`osid.inquiry.rules.AuditProcessorQuery`	`auditProcessorQuery`	the audit processor query
Return	`osid.inquiry.rules.AuditProcessorList`		the list of audit processors
Errors	NULL_ARGUMENT		`auditProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditProcessorQuery` did not originate from `getAuditProcessorQuery()`
Compliance	`mandatory`		This method must be implemented.