OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.CalendarSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.CalendarSearchSession
Description

The interface for governing calendar searches.

MethodsearchAmongCalendars
Description

Execute this search among the given list of calendars.

Parametersosid.id.IdListcalendarIds list of calendars
ErrorsNULL_ARGUMENT calendarIds is null
Compliancemandatory This method must be implemented.
MethodorderCalendarResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.CalendarSearchOrdercalendarSearchOrder calendar search order
ErrorsNULL_ARGUMENT calendarSearchOrder is null
UNSUPPORTED calendarSearchOrder is not of this service
Compliancemandatory This 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.TypecalendarSearchRecordType a calendar search record type
Returnosid.calendaring.records.CalendarSearchRecord the calendar search interface
ErrorsNULL_ARGUMENT calendarSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(calendarSearchRecordType) is false
Compliancemandatory This method must be implemented.