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

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

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 AuditQuery.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Id the Inquest Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquest the inquest
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSearchAuditConstrainerEnablers
Description

Tests if this user can perform AuditConstrainerEnabler searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedInquestView
Description

Federates the view for methods in this session. A federated view will include audit constrainer enablers in inquests which are children of this inquest in the inquest hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedInquestView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this inquest only.

Compliancemandatory This method is must be implemented.
MethodgetAuditConstrainerEnablerQuery
Description

Gets an audit constrainer enabler query.

Returnosid.inquiry.rules.AuditConstrainerEnablerQuery the audit constrainer enabler query
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerEnablersByQuery
Description

Gets a list of AuditConstrainerEnablers matching the given search.

Parametersosid.inquiry.rules.AuditConstrainerEnablerQueryauditConstrainerEnablerQuery the audit constrainer enabler query
Returnosid.inquiry.rules.AuditConstrainerEnablerList the returned AuditConstrainerEnablerList
ErrorsNULL_ARGUMENT auditConstrainerEnablerQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auditConstrainerEnablerQuery did not originate from getAuditConstrainerEnablerQuery()
Compliancemandatory This method must be implemented.