| Interface | osid.course.registration.RegistrationTargetSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.course.registration.RegistrationSearchOrder | ||
osid.course.registration.RegistrationTargetSearchSession | |||
osid.course.registration.RegistrationTargetSmartCourseCatalogSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByCourseOffering | ||
| Description |
Specifies a preference for ordering the result set by course offering. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCourseOfferingSearchOrder | ||
| Description |
Tests if a course offering order is available. | ||
| Return | boolean | true if a course offering order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingSearchOrder | ||
| Description |
Gets the course offering order. | ||
| Return | osid.course.CourseOfferingSearchOrder | the course offering search order | |
| Errors | UNIMPLEMENTED | supportsCourseOfferingSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsCourseSearchOrder()
is true . | |
| Method | getRegistrationTargetSearchOrderRecord | ||
| Description |
Gets the registration target search order record
corresponding to the given registration target record
| ||
| Parameters | osid.type.Type | registrationTargetRecordType | a registration target record type |
| Return | osid.course.registration.records.RegistrationTargetSearchOrderRecord | the registration target search order record | |
| Errors | NULL_ARGUMENT | registrationTargetRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationTargetRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |