Interface | osid.inquiry.rules.InquiryEnablerSmartInquestSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic inquests. An This | ||
Method | getInquestId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Inquest Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquest | ||
Description |
Gets the | ||
Return | osid.inquiry.Inquest | the inquest | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartInquests | ||
Description |
Tests if this user can manage smart inquests. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart inquest management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryEnablerQuery | ||
Description |
Gets an inquiry enabler query. | ||
Return | osid.inquiry.rules.InquiryEnablerQuery | the inquiry enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryEnablerSearchOrder | ||
Description |
Gets an inquiry enabler search order. | ||
Return | osid.inquiry.rules.InquiryEnablerSearchOrder | the inquiry enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyInquiryEnablerQuery | ||
Description |
Applies an inquiry enabler query to this inquest. | ||
Parameters | osid.inquiry.rules.InquiryEnablerQuery | inquiryEnablerQuery | the inquiry enabler query |
Errors | NULL_ARGUMENT | inquiryEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | inquiryEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectInquiryEnablerQuery | ||
Description |
Gets an inquiry enabler query inspector for this inquest. | ||
Return | osid.inquiry.rules.InquiryEnablerQueryInspector | the inquiry enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyInquiryEnablerSequencing | ||
Description |
Applies an inquiry enabler search order to this inquest. | ||
Parameters | osid.inquiry.rules.InquiryEnablerSearchOrder | inquiryEnablerSearchOrder | the inquiry enabler search order |
Errors | NULL_ARGUMENT | inquiryEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | inquiryEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryEnablerQueryFromInspector | ||
Description |
Gets an inquiry enabler query from an inspector. | ||
Parameters | osid.inquiry.rules.InquiryEnablerQueryInspector | inquiryEnablerQueryInspector | an inquiry enabler query inspector |
Return | osid.inquiry.rules.InquiryEnablerQuery | the inquiry enabler query | |
Errors | NULL_ARGUMENT | inquiryEnablerQueryInspector is null | |
UNSUPPORTED | inquiryEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |