OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleSearch
Implementsosid.OsidSearch
Description

ScheduleSearch defines the interface for specifying schedule search options.

MethodsearchAmongSchedules
Description

Execute this search among the given list of schedules.

Parametersosid.id.IdListscheduleIdslist of schedules
ErrorsNULL_ARGUMENT scheduleIds is null
CompliancemandatoryThis method must be implemented.
MethodorderScheduleResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.ScheduleSearchOrderscheduleSearchOrderschedule search order
ErrorsNULL_ARGUMENT scheduleSearchOrder is null
UNSUPPORTED scheduleSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSearchRecord
Description

Gets the schedule search record corresponding to the given schedule search record Type.

Parametersosid.type.TypescheduleSearchRecordTypea schedule search record type
Returnosid.calendaring.records.ScheduleSearchRecordthe schedule search record
ErrorsNULL_ARGUMENT scheduleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.