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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of audits. The audits may be sequenced using the AuditSearchOrder from this session.

This Inquest has a default query that matches any audit and a default search order that specifies no sequencing. The queries may be examined using an AuditQueryInspector. The query may be modified by converting the inspector back to an 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.
MethodcanManageSmartInquests
Description

Tests if this user can manage smart inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart inquest management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuditQuery
Description

Gets an audit query.

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

Gets an audit search order.

Returnosid.inquiry.AuditSearchOrderthe audit search order
CompliancemandatoryThis method must be implemented.
MethodapplyAuditQuery
Description

Applies an audit query to this inquest.

Parametersosid.inquiry.AuditQueryauditQuerythe audit query
ErrorsNULL_ARGUMENT auditQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auditQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecAuditQuery
Description

Gets an audit query inspector for this inquest.

Returnosid.inquiry.AuditQueryInspectorthe audit query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAuditSequencing
Description

Applies an audit search order to this inquest.

Parametersosid.inquiry.AuditSearchOrderauditSearchOrderthe audit search order
ErrorsNULL_ARGUMENT auditSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED auditSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuditQueryFromInspector
Description

Gets an audit query from an inspector.

Parametersosid.inquiry.AuditQueryInspectorauditQueryInspectoran audit query inspector
Returnosid.inquiry.AuditQuerythe audit query
ErrorsNULL_ARGUMENT auditQueryInspector is null
UNSUPPORTED auditQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.