OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditConstrainerInquestSession
Implementsosid.OsidSession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session provides methods to retrieve AuditConstrainer to Inquest mappings. An AuditConstrainer may appear in multiple Inquests. Each inque st 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
MethodcanLookupAuditConstrainerInquestMappings
Description

Tests if this user can perform lookups of audit constrainer/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. T his 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
Compliancemandatory This method must be implemented.
MethoduseComparativeAuditConstrainerInquestView
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.

Compliancemandatory This method is must be implemented.
MethodusePlenaryAuditConstrainerInquestView
Description

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

Compliancemandatory This method is must be implemented.
MethodgetAuditConstrainerIdsByInquest
Description

Gets the list of AuditConstrainerIds associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.id.IdList list of related audit constrainer Ids
ErrorsNOT_FOUND inquestId is not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainersByInquest
Description

Gets the list of AuditConstrainers associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.inquiry.rules.AuditConstrainerList list of related audit constrainers
ErrorsNOT_FOUND inquestId is not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainerIdsByInquests
Description

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

Parametersosid.id.IdListinquestIds list of inquest Ids
Returnosid.id.IdList list of audit constrainer Ids
ErrorsNULL_ARGUMENT inquestIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetAuditConstrainersByInquests
Description

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

Parametersosid.id.IdListinquestIds list of inquest Ids
Returnosid.inquiry.rules.AuditConstrainerList list of audit constrainers
ErrorsNULL_ARGUMENT inquestIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetInquestIdsByAuditConstrainer
Description

Gets the Inquest Ids mapped to an AuditConstrainer.

Parametersosid.id.IdauditConstrainerId Id of an AuditConstrainer
Returnosid.id.IdList list of inquest Ids
ErrorsNOT_FOUND auditConstrainerId is not found
NULL_ARGUMENT auditConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetInquestsByAuditConstrainer
Description

Gets the Inquests mapped to an AuditConstrainer.

Parametersosid.id.IdauditConstrainerId Id of an AuditConstrainer
Returnosid.inquiry.InquestList list of inquests
ErrorsNOT_FOUND auditConstrainerId is not found
NULL_ARGUMENT auditConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.