OSID Specifications
calendaring package
Version 3.1.0
calendaring package
Version 3.1.0
| Interface | osid.calendaring.ScheduleSlotSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidContainableSearchOrder | |||
| Used By | osid.calendaring.ScheduleSearchOrder | ||
osid.calendaring.ScheduleSlotSearchSession | |||
osid.calendaring.ScheduleSlotSmartCalendarSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByWeekdayStart | ||
| Description |
Specified a preference for ordering results by the starting weekday. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWeeklyInterval | ||
| Description |
Specified a preference for ordering results by the weekly interval. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWeekOfMonth | ||
| Description |
Specified a preference for ordering results by the week of the month. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWeekdayTime | ||
| Description |
Specified a preference for ordering results by the weekday time. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFixedInterval | ||
| Description |
Specified a preference for ordering results by the fixed interval. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDuration | ||
| Description |
Specified a preference for ordering results by the duration. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleSlotSearchOrderRecord | ||
| Description |
Gets the schedule slot search order record
corresponding to the given schedule record
| ||
| Parameters | osid.type.Type | scheduleSlotRecordType | a schedule slot record type |
| Return | osid.calendaring.records.ScheduleSlotSearchOrderRecord | the schedule slot search order record | |
| Errors | NULL_ARGUMENT | scheduleSlotRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(scheduleSlotRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |