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

This session provides methods to apply InquiryEnablers to Inquiries. An Inquiry with multiple InquiryEnablers means any positive rule evaluation across the enablers result in an active Inquiry.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignInquiryEnablers
Description

Tests if this user can alter inquiry enabler/inquiry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignInquiryEnablerToInquiry
Description

Adds an existing InquiryEnabler to an Inquiry.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler
osid.id.IdinquiryIdthe Id of the Inquiry
ErrorsALREADY_EXISTS inquiryEnablerId already applied to inquiryId
NOT_FOUND inquiryEnablerId or inquiryId not found
NULL_ARGUMENT inquiryEnablerId or inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignInquiryEnablerFromInquiry
Description

Removes an InquiryEnabler from an Inquiry.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler
osid.id.IdinquiryIdthe Id of the Inquiry
ErrorsNOT_FOUND inquiryEnablerId or inquiryId not found or inquiryEnablerId not applied to inquiryId
NULL_ARGUMENT inquiryEnablerId or inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceInquiryEnablers
Description

Tests if this user can order InquiryEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if InquiryEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveInquiryEnablerAhead
Description

Reorders inquiry enablers for an inquiry by moving the specified inquiry enabler in front of a reference inquiry enabler.

Parametersosid.id.IdinquiryEnablerIdthe Id of an InquiryEnabler
osid.id.IdinquiryIdthe Id of an Inquiry
osid.id.IdreferenceIdthe reference inquiry enabler Id
ErrorsNOT_FOUND inquiryEnablerId, inquiryId, or referenceId not found or, inquiryEnablerId or referenceId not related to inquiryId
NULL_ARGUMENT inquiryEnablerId, inquiryId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveInquiryEnablerBehind
Description

Reorders inquiry enablers for an inquiry by moving the specified inquiry enabler behind a reference inquiry enabler.

Parametersosid.id.IdinquiryEnablerIdthe Id of an InquiryEnabler
osid.id.IdinquiryIdthe Id of an Inquiry
osid.id.IdreferenceIdthe reference inquiry enabler Id
ErrorsNOT_FOUND inquiryEnablerId, inquiryId, or referenceId not found or, inquiryEnablerId or referenceId not related to inquiryId
NULL_ARGUMENT inquiryEnablerId, inquiryId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderInquiryEnablers
Description

Reorders a set of inquiry enablers for an inquiry.

Parametersosid.id.Id[]inquiryEnablerIdsthe Ids for a set of InquiryEnablers
osid.id.IdinquiryIdthe Id of an Inquiry
ErrorsNOT_FOUND inquiryConstraienrId not found or, an inquiryEnablerId not related to inquiryId
NULL_ARGUMENT inquiryEnablerIds or inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.