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

The interface for governing calendar searches.

MethodsearchAmongCalendars
Description

Execute this search among the given list of calendars.

Parametersosid.id.IdListcalendarIdslist of calendars
ErrorsNULL_ARGUMENT calendarIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCalendarResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.CalendarSearchOrdercalendarSearchOrdercalendar search order
ErrorsNULL_ARGUMENT calendarSearchOrder is null
UNSUPPORTED calendarSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCalendarSearchRecord
Description

Gets the calendar search record corresponding to the given calendar search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecalendarSearchRecordTypea calendar search record type
Returnosid.calendaring.records.CalendarSearchRecordthe calendar search interface
ErrorsNULL_ARGUMENT calendarSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(calendarSearchRecordType) is false
CompliancemandatoryThis method must be implemented.