OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.TimePeriodSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getTimePeriods | ||
| Description |
Gets the time period list resulting from the search. | ||
| Return | osid.calendaring.TimePeriodList | the time period list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodQueryInspector | ||
| Description |
Gets the inspector for the query to examine the time periods used in the search. | ||
| Return | osid.calendaring.TimePeriodQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodSearchResultsRecord | ||
| Description |
Gets the time period search results record
corresponding to the given time period search record
| ||
| Parameters | osid.type.Type | timePeriodSearchRecordType | a time period search record type |
| Return | osid.calendaring.records.TimePeriodSearchResultsRecord | the time period search results record | |
| Errors | NULL_ARGUMENT | timePeriodSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(timePeriodSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |