| Interface | osid.calendaring.CalendarSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing calendar searches. | ||
| Method | searchAmongCalendars | ||
| Description |
Execute this search among the given list of calendars. | ||
| Parameters | osid.id.IdList | calendarIds | list of calendars |
| Errors | NULL_ARGUMENT | calendarIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCalendarResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.calendaring.CalendarSearchOrder | calendarSearchOrder | calendar search order |
| Errors | NULL_ARGUMENT | calendarSearchOrder is null | |
| UNSUPPORTED | calendarSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarSearchRecord | ||
| Description |
Gets the calendar search record corresponding to the
given calendar search record | ||
| Parameters | osid.type.Type | calendarSearchRecordType | a calendar search record type |
| Return | osid.calendaring.records.CalendarSearchRecord | the calendar search interface | |
| Errors | NULL_ARGUMENT | calendarSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(calendarSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |