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

This session provides methods for searching among AuditConstrainerEnablers. The search query is constructed using the AuditConstrainerEnablerQuery.

getAuditConstrainerEnablersByQuery() is the basic search method and returns a list of AuditConstrainerEnablers. A more advanced search may be performed with getAuditConstrainerEnablersBySearch().It accepts an AuditConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditConstrainerEnablersBySearch() returns an AuditConstrainerEnablerSearchResults that can be used to access the resulting AuditConstrainerEnablerList or be used to perform a search within the result set through AuditConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetAuditConstrainerEnablerSearch
Description

Gets an audit constrainer enabler search.

Returnosid.inquiry.rules.AuditConstrainerEnablerSearch the audit constrainer enabler search
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablerSearchOrder
Description

Gets an audit constrainer enabler search order. The AuditConstrainerEnablerSearchOrder is supplied to an AuditConstrainerEnablerSearch to specify the ordering of results.

Returnosid.inquiry.rules.AuditConstrainerEnablerSearchOrder the audit constrainer enabler search order
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablersBySearch
Description

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

Parametersosid.inquiry.rules.AuditEnablerQueryauditConstrainerEnablerQuery the audit constrainer enabler query
osid.inquiry.rules.AuditConstrainerEnablerSearchauditConstrainerEnablerSearch the audit constrainer enabler search
Returnosid.inquiry.rules.AuditConstrainerEnablerSearchResults the returned search results
ErrorsNULL_ARGUMENT auditConstrainerEnablerQuery or auditConstrainerEnablerSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auditConstrainerEnablerQuery or auditConstrainerEnablerSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablerQueryFromInspector
Description

Gets an audit constrainer enabler query from an inspector. The inspector is available from an AuditConstrainerEnablerSearchResults.

Parametersosid.inquiry.rules.AuditConstrainerEnablerQueryInspectorauditConstrainerEnablerQueryInspector an audit constrainer enabler query inspector
Returnosid.inquiry.rules.AuditConstrainerEnablerQuery the audit constrainer enabler query
ErrorsNULL_ARGUMENT auditConstrainerEnablerQueryInspector is null
UNSUPPORTED auditConstrainerEnablerQueryInspector is not of this service
Compliancemandatory This method must be implemented.