| Interface | osid.ontology.SubjectSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidFederateableSearchOrder | |||
| Used By | osid.course.requisite.CourseRequirementSearchOrder | ||
osid.ontology.RelevancySearchOrder | |||
osid.ontology.SubjectSearchSession | |||
osid.ontology.SubjectSmartOntologySession | |||
osid.tracking.IssueSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByCode | ||
| Description |
Specifies a preference for ordering the result set by the code. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectSearchOrderRecord | ||
| Description |
Gets the subject search order record corresponding to
the given subject record | ||
| Parameters | osid.type.Type | subjectRecordType | a subject record type |
| Return | osid.ontology.records.SubjectSearchOrderRecord | the subject search order record | |
| Errors | NULL_ARGUMENT | subjectRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subjectRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |