| Interface | osid.inquiry.rules.InquiryEnablerQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Inquiry constrainer enablers may have a query record
indicated by their respective record types. The query record
is accessed via the | ||
| 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 | canSearchInquiryEnablers | ||
| Description |
Tests if this user can perform | ||
| Return | boolean | false if search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedInquestView | ||
| Description |
Federates the view for methods in this session. A federated view will include inquiry enablers in inquests which are children of this broker in the inquest hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedInquestView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only. | ||
| Compliance | mandatory | This method is 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 | getInquiryEnablersByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.inquiry.rules.InquiryEnablerQuery | inquiryEnablerQuery | the inquiry constraienr enabler query |
| Return | osid.inquiry.rules.InquiryEnablerList | the returned InquiryEnablerList | |
| Errors | NULL_ARGUMENT | inquiryEnablerQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | inquiryEnablerQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |