OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.AuditEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching audit enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledAuditId
Description

Matches enablers mapped to the audit.

Parametersosid.id.IdauditIdthe audit Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auditId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuditIdTerms
Description

Clears the audit Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledAuditQuery
Description

Tests if an AuditQuery is available.

Returnboolean true if an audit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledAuditQuery
Description

Gets the query for an audit. Multiple retrievals produce a nested OR term.

Returnosid.inquiry.AuditQuerythe audit query
ErrorsUNIMPLEMENTED supportsRuledAuditQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledAuditQuery() is true.
MethodmatchAnyRuledAudit
Description

Matches enablers mapped to any audit.

Parametersbooleanmatch true for enablers mapped to any audit, false to match enablers mapped to no audits
CompliancemandatoryThis method must be implemented.
MethodclearRuledAuditTerms
Description

Clears the audit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInquestId
Description

Matches enablers mapped to the inquest.

Parametersosid.id.IdinquestIdthe inquest Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT inquestId is null
CompliancemandatoryThis method must be implemented.
MethodclearInquestIdTerms
Description

Clears the inquest Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInquestQuery
Description

Tests if an InquestQuery is available.

Returnboolean true if an inquest query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquestQuery
Description

Gets the query for an inquest. Multiple retrievals produce a nested OR term.

Returnosid.inquiry.InquestQuerythe inquest query
ErrorsUNIMPLEMENTED supportsInquestQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquestQuery() is true.
MethodclearInquestTerms
Description

Clears the inquest query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerQueryRecord
Description

Gets the audit enabler query record corresponding to the given AuditEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeauditEnablerRecordTypean audit enabler record type
Returnosid.inquiry.rules.records.AuditEnablerQueryRecordthe audit enabler query record
ErrorsNULL_ARGUMENT auditEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auditEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.