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

This session provides methods for retrieving Audits. The Audit represents a set of inputs .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated inquest view: All audit methods in this session operate, retrieve and pertain to audits defined explicitly in the current inquest. Using an isolated view is useful for managing Audits with the AuditAdminSession.
  • federated inquest view: All audit methods in this session operate, retrieve and pertain to all audits defined in this inquest and any other audits implicitly available in this inquest through inquest inheritence.
  • active audit view: active audits are returned from methods in this session
  • any status audit view: active and inactive audits are returned from methods in this session

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedInquestView() and useIsolatedInquestView() behave as a radio group and one should be selected before invoking the methods in this session.

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.
MethodcanLookupAudits
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 opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAuditView
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.
MethodusePlenaryAuditView
Description

A complete view of the AuditConstrainer 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 constrainers 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.
MethoduseActiveAuditView
Description

Only active audits are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusAuditView
Description

Borth active and inactive audits are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetAudit
Description

Gets the Audit specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Audit may have a different Id than requested, such as the case where a duplicate Id was assigned to an Audit and retained for compatibility.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

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

Gets an AuditList corresponding to the given IdList.

In plenary mode, the returned list contains all of the audits specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Audits may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Parametersosid.id.IdListauditIdsthe list of Ids to retrieve
Returnosid.inquiry.AuditListthe returned Audit list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT auditIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByGenusType
Description

Gets an AuditList corresponding to the given audit genus Type which does not include audits of genus types derived from the specified Type.

In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Parametersosid.type.TypeauditGenusTypean audit genus type
Returnosid.inquiry.AuditListthe returned Audit list
ErrorsNULL_ARGUMENT auditGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByParentGenusType
Description

Gets an AuditList corresponding to the given audit genus Type and include any additional audits with genus types derived from the specified Type.

In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Parametersosid.type.TypeauditGenusTypean audit genus type
Returnosid.inquiry.AuditListthe returned Audit list
ErrorsNULL_ARGUMENT auditGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByRecordType
Description

Gets an AuditList containing the given audit record Type.

In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Parametersosid.type.TypeauditRecordTypean audit record type
Returnosid.inquiry.AuditListthe returned Audit list
ErrorsNULL_ARGUMENT auditRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByProvider
Description

Gets an AuditList by provider.

In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.inquiry.AuditListthe returned Audit list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAudits
Description

Gets all Audits.

In plenary mode, the returned list contains all known audits or an error results. Otherwise, the returned list may contain only those audits that are accessible through this session.

In active mode, audits are returned that are currently active. In any status mode, active and inactive audits are returned.

Returnosid.inquiry.AuditLista list of Audits
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.