Interface | osid.inquiry.ResponseSearchSession | ||
---|---|---|---|
Implements | osid.inquiry.ResponseQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Responses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getResponseSearch | ||
Description |
Gets a response search. | ||
Return | osid.inquiry.ResponseSearch | the response search | |
Compliance | mandatory | This method must be implemented. | |
Method | getResponseSearchOrder | ||
Description |
Gets a response search order. The | ||
Return | osid.inquiry.ResponseSearchOrder | the response search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getResponsesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.inquiry.ResponseQuery | responseQuery | the response query |
osid.inquiry.ResponseSearch | responseSearch | the response search | |
Return | osid.inquiry.ResponseSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | responseQuery or responseSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | responseQuery or responseSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResponseQueryFromInspector | ||
Description |
Gets a response query from an inspector. The inspector
is available from a | ||
Parameters | osid.inquiry.ResponseQueryInspector | responseQueryInspector | a response query inspector |
Return | osid.inquiry.ResponseQuery | the response query | |
Errors | NULL_ARGUMENT | responseQueryInspector is null | |
UNSUPPORTED | responseQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |