| Interface | osid.calendaring.EventSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
| ||
| Method | searchAmongEvents | ||
| Description |
Execute this search among the given list of events. | ||
| Parameters | osid.id.IdList | eventIds | list of events |
| Errors | NULL_ARGUMENT | eventIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderEventResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.calendaring.EventSearchOrder | eventSearchOrder | event search order |
| Errors | NULL_ARGUMENT | eventSearchOrder is null | |
| UNSUPPORTED | eventSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEventSearchRecord | ||
| Description |
Gets the event search record corresponding to the given
event search record | ||
| Parameters | osid.type.Type | eventSearchRecordType | an event search record type |
| Return | osid.calendaring.records.EventSearchRecord | the event search record | |
| Errors | NULL_ARGUMENT | eventSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(eventSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |