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

This session provides methods to retrieve AuditConstrainerEnabler to Inquest mappings. An AuditConstrainerEnabler 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
MethodcanLookupAuditConstrainerEnablerInquestMappings
Description

Tests if this user can perform lookups of audit constrainer enabler/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.
MethoduseComparativeAuditConstrainerEnablerInquestView
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.
MethodusePlenaryAuditConstrainerEnablerInquestView
Description

A complete view of the AuditConstrainerEnabler 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.
MethodgetAuditConstrainerEnablerIdsByInquest
Description

Gets the list of AuditConstrainerEnablerIds associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.id.IdList list of related audit constrainer enabler 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.
MethodgetAuditConstrainerEnablersByInquest
Description

Gets the list of AuditConstrainerEnablers associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.inquiry.rules.AuditConstrainerEnablerList list of related audit constrainer enablers
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.
MethodgetAuditConstrainerEnablerIdsByInquests
Description

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

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

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

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

Gets the Inquest Ids mapped to an AuditConstrainerEnabler.

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

Gets the Inquests mapped to an AuditConstrainerEnabler.

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