OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.ScheduleSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.ScheduleSearchSession
Description

ScheduleSearch defines the interface for specifying schedule search options.

MethodsearchAmongSchedules
Description

Execute this search among the given list of schedules.

Parametersosid.id.IdListscheduleIds list of schedules
ErrorsNULL_ARGUMENT scheduleIds is null
Compliancemandatory This method must be implemented.
MethodorderScheduleResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.ScheduleSearchOrderscheduleSearchOrder schedule search order
ErrorsNULL_ARGUMENT scheduleSearchOrder is null
UNSUPPORTED scheduleSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetScheduleSearchRecord
Description

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

Parametersosid.type.TypescheduleSearchRecordType a schedule search record type
Returnosid.calendaring.records.ScheduleSearchRecord the schedule search record
ErrorsNULL_ARGUMENT scheduleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(scheduleSearchRecordType) is false
Compliancemandatory This method must be implemented.