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

This session provides methods to retrieve AuditEnabler to Audit mappings. An Audit with multiple AuditEnablers means any positive rule evaluation across the enablers result in an effective Inquiry.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated inquest view: All methods in this session operate, retrieve and pertain audit enablers defined explicitly in the current inquest
  • federated inquest view: All methods in this session operate, retrieve and pertain to all audit enablers defined in this inquest and any other audit enablers implicitly available in this inquest through inquest inheritence.
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.
MethodcanLookupAuditEnablerRules
Description

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

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAuditEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAuditEnablerRuleView
Description

A complete view of the AuditEnabler and Audit returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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 inquest 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.
MethodgetAuditEnablerIdsForAudit
Description

Gets the AuditEnabler Id associated with an Audit.

Parametersosid.id.IdauditId Id of the Audit
Returnosid.id.IdListthe audit enabler Ids
ErrorsNOT_FOUND auditId is not found
NULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablersForAudit
Description

Gets the AuditEnablers associated with an Audit.

Parametersosid.id.IdauditId Id of the Audit
Returnosid.inquiry.rules.AuditEnablerListthe audit enablers
ErrorsNOT_FOUND auditId is not found
NULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditIdsForAuditEnabler
Description

Gets the Audit Ids mapped to an AuditEnabler.

Parametersosid.id.IdauditEnablerId Id of an AuditEnabler
Returnosid.id.IdListlist of audit Ids
ErrorsNOT_FOUND auditEnablerId is not found
NULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsForAuditEnabler
Description

Gets the Audits mapped to an AuditEnabler.

Parametersosid.id.IdauditEnablerId Id of an AuditEnabler
Returnosid.inquiry.AuditListlist of audits
ErrorsNOT_FOUND auditEnablerId is not found
NULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.