| Interface | osid.course.registration.CourseRegistrationSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.course.registration.ActivityRegistrationSearchOrder | ||
osid.course.registration.CourseRegistrationSearchSession | |||
osid.course.registration.CourseRegistrationSmartCourseCatalogSession | |||
osid.course.registration.RegistrationSearchOrder | |||
| 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 search order is available. | ||
| Return | boolean | true if a course offering search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingSearchOrder | ||
| Description |
Gets the course offering search order. | ||
| Return | osid.course.CourseOfferingSearchOrder | the course offering search order | |
| Errors | UNIMPLEMENTED | supportsCourseOfferingSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsCourseOfferingSearchOrder() is true . | |
| Method | orderByStudent | ||
| Description |
Specifies a preference for ordering the result set by student. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsStudentSearchOrder | ||
| Description |
Tests if a student search order is available. | ||
| Return | boolean | true if a student search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentSearchOrder | ||
| Description |
Gets the student search order. | ||
| Return | osid.resource.ResourceSearchOrder | the student search order | |
| Errors | UNIMPLEMENTED | supportsStudentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsStudentSearchOrder() is true . | |
| Method | getCourseRegistrationSearchOrderRecord | ||
| Description |
Gets the course registration search order record
corresponding to the given course registration record
| ||
| Parameters | osid.type.Type | courseRegistrationRecordType | a course registration record type |
| Return | osid.course.registration.records.CourseRegistrationSearchOrderRecord | the course registration search order record | |
| Errors | NULL_ARGUMENT | courseRegistrationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseRegistrationRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |