OSID Specifications
calendaring package
Version 3.1.0
calendaring package
Version 3.1.0
| Interface | osid.calendaring.SupersedingEventSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
| Used By | osid.calendaring.EventSearchOrder | ||
osid.calendaring.SupersedingEventSearchSession | |||
osid.calendaring.SupersedingEventSmartCalendarSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySupersededEvent | ||
| Description |
Specified a preference for ordering results by the superseded event. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSupersededEventSearchOrder | ||
| Description |
Tests if an | ||
| Return | boolean | true if an event search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersededEventSearchOrder | ||
| Description |
Gets the search order for the superseded event. | ||
| Return | osid.calendaring.EventSearchOrder | the event search order | |
| Errors | UNIMPLEMENTED | supportsSupersededEventSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSupersededEventSearchOrder() is true. | |
| Method | orderBySupersedingEvent | ||
| Description |
Specified a preference for ordering results by the superseding event. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSupersedingEventSearchOrder | ||
| Description |
Tests if an | ||
| Return | boolean | true if an event search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingEventSearchOrder | ||
| Description |
Gets the search order for the superseding event. | ||
| Return | osid.calendaring.EventSearchOrder | the event search order | |
| Errors | UNIMPLEMENTED | supportsSupersedingEventSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSupersedingEventSearchOrder() is true. | |
| Method | orderBySupersededDate | ||
| Description |
Specified a preference for ordering results by the superseded date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySupersededEventPosition | ||
| Description |
Specified a preference for ordering results by the superseded event position. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingEventSearchOrderRecord | ||
| Description |
Gets the superseding event search order record
corresponding to the given superseding event record
| ||
| Parameters | osid.type.Type | supersedingEventRecordType | a superseding event record type |
| Return | osid.calendaring.records.SupersedingEventSearchOrderRecord | the superseding event search order record | |
| Errors | NULL_ARGUMENT | supersedingEventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(supersedingEventRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |