Interface | osid.ontology.RelevancySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRelevancies | ||
Description |
Gets the relevancy list resulting from the search. | ||
Return | osid.ontology.RelevancyList | the relevancy list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.ontology.RelevancyQueryInspector | the relevancy query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancySearchResultsRecord | ||
Description |
Gets the relevancy search results record corresponding
to the given relevancy search record | ||
Parameters | osid.type.Type | relevancySearchRecordType | a relevancy search record type |
Return | osid.ontology.records.RelevancySearchResultsRecord | the relevancy search results record | |
Errors | NULL_ARGUMENT | relevancySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(relevancySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |