OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditProcessorEnablerSearchSession
Implementsosid.inquiry.rules.AuditProcessorEnablerQuerySession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session provides methods for searching among AuditProcessorEnablers. The search query is constructed using the AuditProcessorEnablerQuery.

getAuditProcessorEnablersByQuery() is the basic search method and returns a list of AuditProcessorEnablers. A more advanced search may be performed with getAuditProcessorEnablersBySearch().It accepts an AuditProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditProcessorEnablersBySearch() returns an AuditProcessorEnablerSearchResults that can be used to access the resulting AuditProcessorEnablerList or be used to perform a search within the result set through Au ditProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated inquest view: searches include audit processor enablers in inquests of which this inquest is an ancestor in the inquest hierarchy
  • isolated inquest view: searches are restricted to audit processor enablers in this inquest

Audit processor enablers may have a query record indicated by their respective record types. The query record is accessed via the AuditProcessorEnablerQuery.

MethodgetAuditProcessorEnablerSearch
Description

Gets an audit processor enabler search.

Returnosid.inquiry.rules.AuditProcessorEnablerSearch the audit processor enabler search
Compliancemandatory This method must be implemented.
MethodgetAuditProcessorEnablerSearchOrder
Description

Gets an audit processor enabler search order. The AuditProcessorEnablerSearchOrder is supplied to an AuditProcessorEnablerSearch to specify the ordering of results.

Returnosid.inquiry.rules.AuditProcessorEnablerSearchOrder the audit processor enabler search order
Compliancemandatory This method must be implemented.
MethodgetAuditProcessorEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.inquiry.rules.AuditProcessorEnablerQueryauditProcessorEnablerQuery the audit processor enabler query
osid.inquiry.rules.AuditProcessorEnablerSearchauditProcessorEnablerSearch the audit processor enabler search
Returnosid.inquiry.rules.AuditProcessorEnablerSearchResults the returned search results
ErrorsNULL_ARGUMENT auditProcessorEnablerQuery or auditProcessorEnablerSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auditProcessorEnablerQuery or auditProcessorEnablerSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuditProcessorEnablerQueryFromInspector
Description

Gets an audit processor enabler query from an inspector. The inspector is available from an AuditProcessorEnablerSearchResults.

Parametersosid.inquiry.rules.AuditProcessorEnablerQueryInspectorauditProcessorEnablerQueryInspector an audit processor enabler query inspector
Returnosid.inquiry.rules.AuditProcessorEnablerQuery the audit processor enabler query
ErrorsNULL_ARGUMENT auditProcessorEnablerQueryInspector is null
UNSUPPORTED auditProcessorEnablerQueryInspector is not of this service
Compliancemandatory This method must be implemented.