| Interface | osid.calendaring.cycle.CyclicEventSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getCyclicEvents | ||
| Description | 
                     Gets the cyclic event list resulting from the search.  | ||
| Return | osid.calendaring.cycle.CyclicEventList | the cyclic event list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCyclicEventQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.calendaring.cycle.CyclicEventQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCyclicEventSearchResultsRecord | ||
| Description | 
                     Gets the cyclic event search results record 
                    corresponding to the given event search record   | ||
| Parameters | osid.type.Type | cyclicEventSearchRecordType | a cyclic event search record type | 
| Return | osid.calendaring.cycle.records.CyclicEventSearchResultsRecord | the cyclic event search results 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. | |