Interface | osid.offering.ResultSearchSession | ||
---|---|---|---|
Implements | osid.offering.ResultQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Results may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getResultSearch | ||
Description |
Gets an result search. | ||
Return | osid.offering.ResultSearch | the result search | |
Compliance | mandatory | This method must be implemented. | |
Method | getResultSearchOrder | ||
Description |
Gets an result search order. The | ||
Return | osid.offering.ResultSearchOrder | the result search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getResultsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.offering.ResultQuery | resultQuery | the result query |
osid.offering.ResultSearch | resultSearch | the result search | |
Return | osid.offering.ResultSearchResults | the search results | |
Errors | NULL_ARGUMENT | resultQuery or resultSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | resultQuery or resultSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResultQueryFromInspector | ||
Description |
Gets an result query from an inspector. The inspector
is available from an | ||
Parameters | osid.offering.ResultQueryInspector | resultQueryInspector | an result query inspector |
Return | osid.offering.ResultQuery | the result query | |
Errors | NULL_ARGUMENT | resultQueryInspector is null | |
UNSUPPORTED | resultQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |