Interface | osid.calendaring.CalendarSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCalendars | ||
Description |
Gets the calendar list resulting from the search. | ||
Return | osid.calendaring.CalendarList | the calendar list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.CalendarQueryInspector | the calendar query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarSearchResultsRecord | ||
Description |
Gets the calendar search results record corresponding
to the given calendar search record | ||
Parameters | osid.type.Type | calendarSearchRecordType | a calendar search record type |
Return | osid.calendaring.records.CalendarSearchResultsRecord | the calendar search results record | |
Errors | NULL_ARGUMENT | calendarSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(calendarSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |