OSID Specifications
course package
Version 3.1.0
course package
Version 3.1.0
| Interface | osid.course.TermSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidFederateableSearchOrder | |||
| Used By | osid.course.ActivitySearchOrder | ||
osid.course.CourseOfferingSearchOrder | |||
osid.course.TermSearchSession | |||
osid.course.TermSmartCourseCatalogSession | |||
osid.course.chronicle.CourseEntrySearchOrder | |||
osid.course.chronicle.CredentialEntrySearchOrder | |||
osid.course.chronicle.ProgramEntrySearchOrder | |||
osid.course.program.ProgramOfferingSearchOrder | |||
osid.course.registration.request.RegistrationRequestSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDisplayLabel | ||
| Description |
Specifies a preference for ordering the result set by course title. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOpenDate | ||
| Description |
Specified a preference for ordering results by the open date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRegistrationStart | ||
| Description |
Specified a preference for ordering results by registration start. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRegistrationEnd | ||
| Description |
Specified a preference for ordering results by registration end. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRegistrationDuration | ||
| Description |
Specifies a preference for ordering the result set by the duration of the registration period. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByClassesStart | ||
| Description |
Specified a preference for ordering results by classes start. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByClassesEnd | ||
| Description |
Specified a preference for ordering results by classes end. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByClassesDuration | ||
| Description |
Specifies a preference for ordering the result set by the duration of the classes period. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAddDate | ||
| Description |
Specifies a preference for ordering the result set by the add date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDropDate | ||
| Description |
Specifies a preference for ordering the result set by the drop date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFinalExamStart | ||
| Description |
Specified a preference for ordering results by final exam start. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFinalExamEnd | ||
| Description |
Specified a preference for ordering results by final exam end. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFinalExamDuration | ||
| Description |
Specifies a preference for ordering the result set by the duration of the final exam period. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCloseDate | ||
| Description |
Specifies a preference for ordering the result set by the close date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermSearchOrderRecord | ||
| Description |
Gets the term search order record corresponding to the
given course record | ||
| Parameters | osid.type.Type | termRecordType | a term record type |
| Return | osid.course.records.TermSearchOrderRecord | the term search order record | |
| Errors | NULL_ARGUMENT | termRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(termRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |