OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.SupersedingEventSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
| ||
| Method | searchAmongSupersedingEvents | ||
| Description |
Execute this search among the given list of superseding events. | ||
| Parameters | osid.id.IdList | supersedingEventIds | list of superseding events |
| Errors | NULL_ARGUMENT | supersedingEventIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderSupersedingEventResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.calendaring.SupersedingEventSearchOrder | supersedingEventSearchOrder | superseding event search order |
| Errors | NULL_ARGUMENT | supersedingEventSearchOrder is null | |
| UNSUPPORTED | superedingEventSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingEventSearchRecord | ||
| Description |
Gets the superseding event search record corresponding
to the given superseding event search record | ||
| Parameters | osid.type.Type | supersedingEventSearchRecordType | a superseding event search record type |
| Return | osid.calendaring.records.SupersedingEventSearchRecord | the superseding event search record | |
| Errors | NULL_ARGUMENT | supersedingEventSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(supersedingEventSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |