OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.AuditEnablerSearchSession
Implementsosid.inquiry.rules.AuditEnablerQuerySession
Description

This session provides methods for searching among AuditEnabler objects. The search query is constructed using the AuditEnableryQuery.

getAuditEnablersByQuery() is the basic search method and returns a list of AuditEnablers. A more advanced search may be performed with getAuditEnablersBySearch(). It accepts an AuditEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as inquiry. getAuditEnablersBySearch() returns an AuditEnablerSearchResults that can be used to access the resulting AuditEnablerList or be used to perform a search within the result set through AuditEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

AuditEnablers may have a query record indicated by their respective record types. The query record is accessed via the AuditEnablerQuery.

MethodgetAuditEnablerSearch
Description

Gets an audit enabler search.

Returnosid.inquiry.rules.AuditEnablerSearchthe audit enabler search
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerSearchOrder
Description

Gets an audit enabler search order. The AuditEnablerSearchOrder is supplied to an AuditEnablerSearch to specify the ordering of results.

Returnosid.inquiry.rules.AuditEnablerSearchOrderthe audit enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablersBySearch
Description

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

Parametersosid.inquiry.rules.AuditEnablerQueryauditEnablerQuerythe audit enabler query
osid.inquiry.rules.AuditEnablerSearchauditEnablerSearchthe audit enabler search
Returnosid.inquiry.rules.AuditEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT auditEnablerQuery or auditEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auditEnablerQuery or auditEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerQueryFromInspector
Description

Gets an audit enabler query from an inspector. The inspector is available from an AuditEnablerSearchResults.

Parametersosid.inquiry.rules.AuditEnablerQueryInspectorauditEnablerQueryInspectoran audit enabler query inspector
Returnosid.inquiry.rules.AuditEnablerQuerythe audit enabler query
ErrorsNULL_ARGUMENT auditEnablerQueryInspector is null
UNSUPPORTED auditEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.