OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.OffsetEventSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
| ||
| Method | searchAmongOffsetEvents | ||
| Description |
Execute this search among the given list of offset events. | ||
| Parameters | osid.id.IdList | offsetEventIds | list of offset events |
| Errors | NULL_ARGUMENT | offsetEventIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOffsetEventResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.calendaring.OffsetEventSearchOrder | offsetEventSearchOrder | offset event search order |
| Errors | NULL_ARGUMENT | offsetEventSearchOrder is null | |
| UNSUPPORTED | offsetEventSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffsetEventSearchRecord | ||
| Description |
Gets the offset event search record corresponding to
the given offset event search record | ||
| Parameters | osid.type.Type | offsetEventSearchRecordType | an offset event search record type |
| Return | osid.calendaring.records.OffsetEventSearchRecord | the offset event search record | |
| Errors | NULL_ARGUMENT | offsetEventSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offsetEventSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |