| Interface | osid.ontology.RelevancySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
| ||
| Method | searchAmongRelevancies | ||
| Description |
Execute this search among the given list of relevancies. | ||
| Parameters | osid.id.IdList | relevancyIds | list of relevancies |
| Errors | NULL_ARGUMENT | relevancyIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderRelevancyResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ontology.RelevancySearchOrder | relevancySearchOrder | relevancy search order |
| Errors | NULL_ARGUMENT | relevancySearchOrder is null | |
| UNSUPPORTED | relevancySearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelevancySearchRecord | ||
| Description |
Gets the relevancy search record corresponding to the
given relevancy search record | ||
| Parameters | osid.type.Type | relevancySearchRecordType | a relevancy search record type |
| Return | osid.ontology.records.RelevancySearchRecord | the relevancy search record | |
| Errors | NULL_ARGUMENT | relevancySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(relevancySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |