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

ScheduleSlotSearch defines the interface for specifying schedule slot search options.

MethodsearchAmongScheduleSlots
Description

Execute this search among the given list of schedule slots.

Parametersosid.id.IdListscheduleSlotIdslist of schedule slots
ErrorsNULL_ARGUMENT scheduleSlotIds is null
CompliancemandatoryThis method must be implemented.
MethodorderScheduleSlotResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.ScheduleSlotSearchOrderscheduleSlotSearchOrderschedule slot search order
ErrorsNULL_ARGUMENT scheduleSlotSearchOrder is null
UNSUPPORTED scheduleSlotSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotSearchRecord
Description

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

Parametersosid.type.TypescheduleSlotSearchRecordTypea schedule slot search record type
Returnosid.calendaring.records.ScheduleSlotSearchRecordthe schedule slot search record
ErrorsNULL_ARGUMENT scheduleSlotSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleSlotSearchRecordType) is false
CompliancemandatoryThis method must be implemented.