Interface | osid.calendaring.ScheduleSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongSchedules | ||
Description |
Execute this search among the given list of schedules. | ||
Parameters | osid.id.IdList | scheduleIds | list of schedules |
Errors | NULL_ARGUMENT | scheduleIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderScheduleResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.ScheduleSearchOrder | scheduleSearchOrder | schedule search order |
Errors | NULL_ARGUMENT | scheduleSearchOrder is null | |
UNSUPPORTED | scheduleSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleSearchRecord | ||
Description |
Gets the schedule search record corresponding to the
given schedule search record | ||
Parameters | osid.type.Type | scheduleSearchRecordType | a schedule search record type |
Return | osid.calendaring.records.ScheduleSearchRecord | the schedule search 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. |