Interface | osid.calendaring.ScheduleSlotSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getScheduleSlots | ||
Description |
Gets the schedule list resulting from the search. | ||
Return | osid.calendaring.ScheduleSlotList | the schedule slot list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleSlotQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.calendaring.ScheduleSlotQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleSlotSearchResultsRecord | ||
Description |
Gets the schedule slot record corresponding to the
given schedule slot search record | ||
Parameters | osid.type.Type | scheduleSlotSearchRecordType | a schedule slot search record type |
Return | osid.calendaring.records.ScheduleSlotSearchResultsRecord | the schedule slot search results record | |
Errors | NULL_ARGUMENT | scheduleSlotSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(scheduleSlotSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |