| Interface | osid.inquiry.InquestSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.InquestQuerySession | ||
| Used By | osid.inquiry.InquiryManager | ||
osid.inquiry.InquiryProxyManager | |||
| Description |
This session provides methods for searching among
getInquestsByQuery() is the basic search method
and returns a list of Inquests. A more advanced
search may be performed with
getInquestsBySearch().It accepts an
InquestSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getInquestsBySearch()
returns an InquestSearchResults that can be used
to access the resulting InquestList or be used to
perform a search within the result set through
InquestSearch.
Inquests may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getInquestSearch | ||
| Description |
Gets an inquest search. | ||
| Return | osid.inquiry.InquestSearch | the inquest search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestSearchOrder | ||
| Description |
Gets an inquest search order. The
| ||
| Return | osid.inquiry.InquestSearchOrder | the inquest search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.InquestQuery | inquestQuery | the inquest query |
osid.inquiry.InquestSearch | inquestSearch | the inquest search | |
| Return | osid.inquiry.InquestSearchResults | the inquest search results | |
| Errors | NULL_ARGUMENT | inquestQuery or inquestSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | inquestQuery or inquestSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestQueryFromInspector | ||
| Description |
Gets an inquest query from an inspector. The inspector
is available from an | ||
| Parameters | osid.inquiry.InquestQueryInspector | inquestQueryInspector | an inquest query inspector |
| Return | osid.inquiry.InquestQuery | the inquest query | |
| Errors | NULL_ARGUMENT | inquestQueryInspector is null | |
| UNSUPPORTED | inquestQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |