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

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

This session defines views that offer differing behaviors for searching.

  • federated action group view: searches include audits in action groups of which this action group is an ancestor in the action group hierarchy
  • isolated action group view: searches are restricted to audits in this action group

Audits 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.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.
MethodcanSearchAudits
Description

Tests if this user can perform Audit 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 audits in inquests which are children of this action group 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.
MethodgetAuditQuery
Description

Gets an audit query.

Returnosid.inquiry.AuditQuerythe audit query
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByQuery
Description

Gets a list of Audits matching the given audit query.

Parametersosid.inquiry.AuditQueryauditQuerythe audit query
Returnosid.inquiry.AuditListthe returned AuditList
ErrorsNULL_ARGUMENT auditQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auditQuery is not of this service
CompliancemandatoryThis method must be implemented.