OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.CalendarSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.CalendarSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetCalendars
Description

Gets the calendar list resulting from the search.

Returnosid.calendaring.CalendarList the calendar list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCalendarQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.calendaring.CalendarQueryInspector the calendar query inspector
Compliancemandatory This method must be implemented.
MethodgetCalendarSearchResultsRecord
Description

Gets the calendar search results 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.CalendarSearchResultsRecord the calendar search results record
ErrorsNULL_ARGUMENT calendarSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(calendarSearchRecordType) is false
Compliancemandatory This method must be implemented.