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

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

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

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

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchAuditEnablers
Description

Tests if this user can perform AuditEnabler lookups. 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
CompliancemandatoryThis method must be implemented.
MethoduseFederatedInquestView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedInquestView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetAuditEnablerQuery
Description

Gets an audit enabler query.

Returnosid.inquiry.rules.AuditEnablerQuerythe audit enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablersByQuery
Description

Gets a list of AuditEnablers matching the given search.

Parametersosid.inquiry.rules.AuditEnablerQueryauditEnablerQuerythe inquiry constraienr enabler query
Returnosid.inquiry.rules.AuditEnablerListthe returned AuditEnablerList
ErrorsNULL_ARGUMENT auditEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auditEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.