OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CalendarSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetCalendars
Description

Gets the calendar list resulting from the search.

Returnosid.calendaring.CalendarListthe calendar list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCalendarQueryInspector
Description

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

Returnosid.calendaring.CalendarQueryInspectorthe calendar query inspector
CompliancemandatoryThis 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.TypecalendarSearchRecordTypea calendar search record type
Returnosid.calendaring.records.CalendarSearchResultsRecordthe calendar search results record
ErrorsNULL_ARGUMENT calendarSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(calendarSearchRecordType) is false
CompliancemandatoryThis method must be implemented.