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

Interface	osid.inquiry.rules.AuditProcessorSearchSession
Implements	`osid.inquiry.rules.AuditProcessorQuerySession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session provides methods for searching among `AuditProcessors`. The search query is constructed using the `AuditProcessorQuery`. `getAuditProcessorsByQuery()` is the basic search method and returns a list of `AuditProcessors`. A more advanced search may be performed with `getAuditProcessorsBySearch()`. It accepts an `AuditProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAuditProcessorsBySearch()` returns an `AuditProcessorSearchResults` that can be used to access the resulting `AuditProcessorList` or be used to perform a search within the result set through Au `ditProcessorSearch`. 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 `AuditProcessorQuery`.
Method	getAuditProcessorSearch
Description	Gets an audit processor search.
Return	`osid.inquiry.rules.AuditProcessorSearch`		the audit processor search
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorSearchOrder
Description	Gets an audit processor search order. The `AuditProcessorSearchOrder` is supplied to an `AuditProcessorSearch` to specify the ordering of results.
Return	`osid.inquiry.rules.AuditProcessorSearchOrder`		the audit processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inquiry.rules.AuditProcessorQuery`	`auditProcessorQuery`	the audit processor query
Parameters	`osid.inquiry.rules.AuditProcessorSearch`	`auditProcessorSearch`	the audit processor search
Return	`osid.inquiry.rules.AuditProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`auditProcessorQuery` or `auditProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditProcessorQuery` or `auditProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorQueryFromInspector
Description	Gets an audit processor query from an inspector. The inspector is available from an `AuditProcessorSearchResults`.
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.