Interface | osid.calendaring.cycle.CyclicEventSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongCyclicEvents | ||
Description |
Execute this search among the given list of events. | ||
Parameters | osid.id.IdList | cyclicEventIds | list of events |
Errors | NULL_ARGUMENT | cyclicEventIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCyclicEventResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.cycle.CyclicEventSearchOrder | cyclicEventSearchOrder | event search order |
Errors | NULL_ARGUMENT | cyclicEventSearchOrder is null | |
UNSUPPORTED | cyclicEventSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventSearchRecord | ||
Description |
Gets the cyclic event search record corresponding to
the given event search record | ||
Parameters | osid.type.Type | cyclicEventSearchRecordType | a cyclic event search record type |
Return | osid.calendaring.cycle.records.CyclicEventSearchRecord | the cyclic event search record | |
Errors | NULL_ARGUMENT | cyclicEventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(cyclicEventSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |