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

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

Tests if this user can perform lookups of inquiry 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. 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.
MethoduseComparativeInquiryEnablerInquestView
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.
MethodusePlenaryInquiryEnablerInquestView
Description

A complete view of the InquiryEnabler 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.
MethodgetInquiryEnablerIdsByInquest
Description

Gets the list of InquiryEnablerIds associated with an Inquest.

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.id.IdListlist of related inquiry enabler 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.
MethodgetInquiryEnablersByInquest
Description

Gets the list of inquiry enablers associated with an Inquest.

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

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

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

Gets the list of inquiry enablers corresponding to a list of Inquests.

Parametersosid.id.IdListinquestIdslist of inquest Ids
Returnosid.inquiry.rules.InquiryEnablerListlist of inquiry enablers
ErrorsNULL_ARGUMENT inquestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestIdsByInquiryEnabler
Description

Gets the Inquest Ids mapped to an InquiryEnabler.

Parametersosid.id.IdinquiryEnablerId Id of an InquiryEnabler
Returnosid.id.IdListlist of inquests
ErrorsNOT_FOUND inquiryEnablerId is not found
NULL_ARGUMENT inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByInquiryEnabler
Description

Gets the Inquests mapped to an InquiryEnabler.

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