Interface | osid.ontology.RelevancySearchSession | ||
---|---|---|---|
Implements | osid.ontology.RelevancyQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Relevancies may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getRelevancySearch | ||
Description |
Gets a relevancy search. | ||
Return | osid.ontology.RelevancySearch | the relevancy search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancySearchOrder | ||
Description |
Gets a relevancy search order. The | ||
Return | osid.ontology.RelevancySearchOrder | the relevancy search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevanciesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.ontology.RelevancyQuery | relevancyQuery | the relevancy query |
osid.ontology.RelevancySearch | relevancySearch | the relevancy search | |
Return | osid.ontology.RelevancySearchResults | the relevancy search results | |
Errors | NULL_ARGUMENT | relevancyQuery or relevancySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relevancySearch or relevancyQuery is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyQueryFromInspector | ||
Description |
Gets a relevancy query from an inspector. The inspector
is available from a | ||
Parameters | osid.ontology.RelevancyQueryInspector | relevancyQueryInspector | a relevancy query inspector |
Return | osid.ontology.RelevancyQuery | the relevancy query | |
Errors | NULL_ARGUMENT | relevancyQueryInspector is null | |
UNSUPPORTED | relevancyQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |