OSID Specifications
ontology package
Version 3.0.0
ontology package
Version 3.0.0
| Interface | osid.ontology.RelevancySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.ontology.RelevancySearchSession | ||
osid.ontology.RelevancySmartOntologySession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySubject | ||
| Description |
Specified a preference for ordering results by the subject. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSubjectSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a subject search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectSearchOrder | ||
| Description |
Gets the search order for a subject. | ||
| Return | osid.ontology.SubjectSearchOrder | the subject search order | |
| Errors | UNIMPLEMENTED | supportsSubjectSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSubjectSearchOrder() is true . | |
| Method | getRelevancySearchOrderRecord | ||
| Description |
Gets the relevancy search order record corresponding to
the given commitment record | ||
| Parameters | osid.type.Type | relevancyRecordType | a relevancy record type |
| Return | osid.ontology.records.RelevancySearchOrderRecord | the relevancy search order record | |
| Errors | NULL_ARGUMENT | relevancyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(relevancyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |