OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
course package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.CourseOfferingSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByCourse | ||
| Description |
Specifies a preference for ordering the result set by course. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCourseSearchOrder | ||
| Description |
Tests if a course order is available. | ||
| Return | boolean | true if a course order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseSearchOrder | ||
| Description |
Gets the course order. | ||
| Return | osid.course.CourseSearchOrder | the course search order | |
| Errors | UNIMPLEMENTED | supportsCourseSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsCourseSearchOrder()
is true. | |
| Method | orderByTerm | ||
| Description |
Specifies a preference for ordering the result set by term. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsTermSearchOrder | ||
| Description |
Tests if a term order is available. | ||
| Return | boolean | true if a term order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermSearchOrder | ||
| Description |
Gets the term order. | ||
| Return | osid.course.TermSearchOrder | the term search order | |
| Errors | UNIMPLEMENTED | supportsTermSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsTermSearchOrder()
is true. | |
| Method | orderByTitle | ||
| Description |
Specifies a preference for ordering the result set by course offering title. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByNumber | ||
| Description |
Specifies a preference for ordering the result set by course offering number. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequiresRegistration | ||
| Description |
Specifies a preference for ordering the result set by course offerings requiring registration. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumSeats | ||
| Description |
Specifies a preference for ordering the result set by the minimum seats. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMaximumSeats | ||
| Description |
Specifies a preference for ordering the result set by the maximum seats. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByURL | ||
| Description |
Specifies a preference for ordering the result set by url. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByScheduleInfo | ||
| Description |
Specifies a preference for ordering the result set by schedule info. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByEvent | ||
| Description |
Specifies a preference for ordering the result set by event. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsEventSearchOrder | ||
| Description |
Tests if an event search order is available. | ||
| Return | boolean | true if an event order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEventSearchOrder | ||
| Description |
Gets the event order. | ||
| Return | osid.calendaring.EventSearchOrder | the event search order | |
| Errors | UNIMPLEMENTED | supportsEventSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsEventSearchOrder()
is true. | |
| Method | getCourseOfferingSearchOrderRecord | ||
| Description |
Gets the course offering search order record
corresponding to the given course offering record | ||
| Parameters | osid.type.Type | courseOfferingRecordType | a course offering record type |
| Return | osid.course.records.CourseOfferingSearchOrderRecord | the course offering search order record | |
| Errors | NULL_ARGUMENT | courseOfferingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseOfferingRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |