OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
course registration package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.registration.ActivityBundleSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| 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 | getActivityBundleSearchOrderRecord | ||
| Description |
Gets the activity bundle search order record
corresponding to the given activity bundle record | ||
| Parameters | osid.type.Type | activityBundleRecordType | an activity bundle record type |
| Return | osid.course.registration.records.ActivityBundleSearchOrderRecord | the activity bundle search order record | |
| Errors | NULL_ARGUMENT | activityBundleRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityBundleRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |