| Interface | osid.course.registration.request.RegistrationRequestSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRequestSearchOrder | ||
| Used By | osid.course.registration.request.RegistrationRequestItemSearchOrder | ||
osid.course.registration.request.RegistrationRequestSearchSession | |||
osid.course.registration.request.RegistrationRequestSmartCourseCatalogSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByTerm | ||
| Description |
Orders the results by term. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsTermSearchOrder | ||
| Description |
Tests if a term search order is available. | ||
| Return | boolean | true if a term search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermSearchOrder | ||
| Description |
Gets the term search order. | ||
| Return | osid.course.TermSearchOrder | the term search order | |
| Errors | ILLEGAL_STATE | supportsTermSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestSearchOrderRecord | ||
| Description |
Gets the registration request search order record
corresponding to the given registration request record
| ||
| Parameters | osid.type.Type | registrationRequestRecordType | a registration request record type |
| Return | osid.course.registration.request.records.RegistrationRequestSearchOrderRecord | the registration request search order record | |
| Errors | NULL_ARGUMENT | registrationRequestRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationRequestRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |