OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.ScheduleSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getSchedules | ||
| Description |
Gets the schedule list resulting from the search. | ||
| Return | osid.calendaring.ScheduleList | the schedule list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.calendaring.ScheduleQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleSearchResultsRecord | ||
| Description |
Gets the schedule search results record corresponding
to the given schedule search record | ||
| Parameters | osid.type.Type | scheduleSearchRecordType | a schedule search record type |
| Return | osid.calendaring.records.ScheduleSearchResultsRecord | the schedule search results record | |
| Errors | NULL_ARGUMENT | scheduleSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(scheduleSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |