| Interface | osid.calendaring.cycle.CyclicTimePeriodSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | This interface provides a means to capture results of a search. | ||
| Method | getCyclicTimePeriods | ||
| Description | Gets the cyclic time period list resulting from the search. | ||
| Return | osid.calendaring.cycle.CyclicTimePeriodList | the cyclic time period list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCyclicTimePeriodQueryInspector | ||
| Description | Gets the inspector for the query to examine the cyclic time periods used in the search. | ||
| Return | osid.calendaring.cycle.CyclicTimePeriodQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCyclicTimePeriodSearchResultsRecord | ||
| Description | Gets the cyclic time period search results record 
                    corresponding to the given cyclic time period search 
                    record  | ||
| Parameters | osid.type.Type | cyclicTimePeriodSearchRecordType | a cyclic time period search record type | 
| Return | osid.calendaring.cycle.records.CyclicTimePeriodSearchResultsRecord | the cyclic time period search results record | |
| Errors | NULL_ARGUMENT |  cyclicTimePeriodSearchRecordType is null  | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(cyclicTimePeriodSearchRecordType) is 
false  | ||
| Compliance | mandatory | This method must be implemented. | |