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

This session provides methods to retrieve Audit to Inquest mappings. An Audit may appear in multiple Inquest objects. Each inquest may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupAuditInquestMappings
Description

Tests if this user can perform lookups of audit/inquest 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.
MethoduseComparativeAuditInquestView
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.
MethodusePlenaryAuditInquestView
Description

A complete view of the Audit and Inquest 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.
MethodgetAuditIdsByInquest
Description

Gets the list of Audit Ids associated with a Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.id.IdListlist of related audit Ids
ErrorsNOT_FOUND inquestId is not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByInquest
Description

Gets the list of audits associated with a Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.inquiry.AuditListlist of related audits
ErrorsNOT_FOUND inquestId is not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditIdsByInquests
Description

Gets the list of Audit Ids corresponding to a list of Inquests.

Parametersosid.id.IdListinquestIdslist of inquest Ids
Returnosid.id.IdListlist of audit Ids
ErrorsNULL_ARGUMENT inquestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuditsByInquests
Description

Gets the list of audits corresponding to a list of Inquests.

Parametersosid.id.IdListinquestIdslist of inquest Ids
Returnosid.inquiry.AuditListlist of audits
ErrorsNULL_ARGUMENT inquestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestIdsByAudit
Description

Gets the Inquest Ids mapped to an Audit.

Parametersosid.id.IdauditId Id of an Audit
Returnosid.id.IdListlist of inquests
ErrorsNOT_FOUND auditId is not found
NULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByAudit
Description

Gets the Inquests mapped to an Audit.

Parametersosid.id.IdauditId Id of an Audit
Returnosid.inquiry.InquestListlist of inquests
ErrorsNOT_FOUND auditId is not found
NULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.