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

This session provides methods for searching among AuditConstrainers. The search query is constructed using the AuditConstrainerQuery.

getAuditConstrainersByQuery() is the basic search method and returns a list of AuditConstrainers. A more advanced search may be performed with getAuditConstrainersBySearch(). It accepts an AuditConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditConstrainersBySearch() returns an AuditConstrainerSearchResults that can be used to access the resulting AuditConstrainerList or be used to perform a search within the result set through Au ditConstrainerSearch.

This session defines views that offer differing behaviors for searching.

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

Audit constrainers may have a query record indicated by their respective record types. The query record is accessed via the AuditConstrainerQuery.

MethodgetAuditConstrainerSearch
Description

Gets an audit constrainer search.

Returnosid.inquiry.rules.AuditConstrainerSearch the audit constrainer search
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerSearchOrder
Description

Gets an audit constrainer search order. The AuditConstrainerSearchOrder is supplied to an AuditConstrainerSearch to specify the ordering of results.

Returnosid.inquiry.rules.AuditConstrainerSearchOrder the audit constrainer search order
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainersBySearch
Description

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

Parametersosid.inquiry.rules.AuditConstrainerQueryauditConstrainerQuery the audit constrainer query
osid.inquiry.rules.AuditConstrainerSearchauditConstrainerSearch the audit constrainer search
Returnosid.inquiry.rules.AuditConstrainerSearchResults the returned search results
ErrorsNULL_ARGUMENT auditConstrainerQuery or auditConstrainerSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auditConstrainerQuery or auditConstrainerSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerQueryFromInspector
Description

Gets an audit constrainer query from an inspector. The inspector is available from an AuditConstrainerSearchResults.

Parametersosid.inquiry.rules.AuditConstrainerQueryInspectorauditConstrainerQueryInspector an audit constrainer query inspector
Returnosid.inquiry.rules.AuditConstrainerQuery the audit constrainer query
ErrorsNULL_ARGUMENT auditConstrainerQueryInspector is null
UNSUPPORTED auditConstrainerQueryInspector is not of this service
Compliancemandatory This method must be implemented.