| Interface | osid.inquiry.InquirySearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.InquiryQuerySession | ||
| Used By | osid.inquiry.InquiryManager | ||
osid.inquiry.InquiryProxyManager | |||
| Description |
This session provides methods for searching among
getInquiriesByQuery() is the basic search method
and returns a list of Inquiries. A more advanced
search may be performed with
getInquiriesBySearch().It accepts an
InquirySearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getInquiriesBySearch()
returns an InquirySearchResults that can be used
to access the resulting InquiryList or be used to
perform a search within the result set through
InquirySearch.
This session defines views that offer differing behaviors for searching.
Inquiries may have a record indicated by their respective
record types. The query record is accessed via the
| ||
| Method | getInquirySearch | ||
| Description |
Gets an inquiry search. | ||
| Return | osid.inquiry.InquirySearch | the inquiry search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquirySearchOrder | ||
| Description |
Gets an inquiry search order. The
| ||
| Return | osid.inquiry.InquirySearchOrder | the inquiry search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiriesBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.InquiryQuery | inquiryQuery | the inquiry query |
osid.inquiry.InquirySearch | inquirySearch | the inquiry search | |
| Return | osid.inquiry.InquirySearchResults | the inquiry search results | |
| Errors | NULL_ARGUMENT | inquiryQuery or inquirySearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | inquiryQuery or inquirySearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryQueryFromInspector | ||
| Description |
Gets an inquiry query from an inspector. The inspector
is available from an | ||
| Parameters | osid.inquiry.InquiryQueryInspector | inquiryQueryInspector | an inquiry query inspector |
| Return | osid.inquiry.InquiryQuery | the inquiry query | |
| Errors | NULL_ARGUMENT | inquiryQueryInspector is null | |
| UNSUPPORTED | inquiryQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |