Interface | osid.calendaring.RecurringEventSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRecurringEvents | ||
Description |
Gets the recurring event list resulting from the search. | ||
Return | osid.calendaring.RecurringEventList | the recurring event list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.RecurringEventQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventSearchResultsRecord | ||
Description |
Gets the recurring event search results record
corresponding to the given recurring event search record
| ||
Parameters | osid.type.Type | recurringEventSearchRecordType | a recurring event search record type |
Return | osid.calendaring.records.RecurringEventSearchResultsRecord | the recurring event search results record | |
Errors | NULL_ARGUMENT | recurringEventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(recurringEventSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |