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

This session provides methods to retrieve AuditprocessorEnabler to Inquest mappings. An AuditProcessorEnabler 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
MethodcanLookupAuditProcessorEnablerInquestMappings
Description

Tests if this user can perform lookups of audit processor 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.
MethoduseComparativeAuditProcessorEnablerInquestView
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.
MethodusePlenaryAuditProcessorEnablerInquestView
Description

A complete view of the AuditProcessorEnabler 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.
MethodgetAuditProcessorEnablerIdsByInquest
Description

Gets the list of AuditProcessorEnablerIds associated with an Inquest.

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

Gets the list of AuditProcessorEnablers associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.inquiry.rules.AuditProcessorEnablerList list of related audit processor 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.
MethodgetAuditProcessorEnablerIdsByInquests
Description

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

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

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

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

Gets the Inquest Ids mapped to an AuditProcessorEnabler.

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

Gets the Inquests mapped to an AuditProcessorEnabler.

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