| Interface | osid.inquiry.rules.InquiryEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.rules.InquiryEnablerQuerySession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
getInquiryEnablersByQuery() is the basic search
method and returns a list of InquiryEnablers. A
more advanced search may be performed with
getInquiryEnablersBySearch(). It accepts an
InquiryEnablerSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as inquiry.
getInquiryEnablersBySearch() returns an
InquiryEnablerSearchResults that can be used to
access the resulting InquiryEnablerList or be
used to perform a search within the result set through
InquiryEnablerSearch.
This session defines views that offer differing behaviors for searching.
InquiryEnablers may have a query record indicated
by their respective record types. The query record is accessed
via the InquiryEnablerQuery. | ||
| Method | getInquiryEnablerSearch | ||
| Description |
Gets an inquiry enabler search. | ||
| Return | osid.inquiry.rules.InquiryEnablerSearch | the inquiry enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryEnablerSearchOrder | ||
| Description |
Gets an inquiry enabler search order. The
| ||
| Return | osid.inquiry.rules.InquiryEnablerSearchOrder | the inquiry enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.rules.InquiryEnablerQuery | inquiryEnablerQuery | the inquiry enabler query |
osid.inquiry.rules.InquiryEnablerSearch | inquiryEnablerSearch | the inquiry enabler search | |
| Return | osid.inquiry.rules.InquiryEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | inquiryEnablerQuery or inquiryEnablerSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | inquiryEnablerQuery or inquiryEnablerSearch is
not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryEnablerQueryFromInspector | ||
| Description |
Gets an inquiry enabler query from an inspector. The
inspector is available from an
| ||
| 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. | |