OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.RecurringEventSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.RecurringEventSearchSession
Description

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

MethodgetRecurringEvents
Description

Gets the recurring event list resulting from the search.

Returnosid.calendaring.RecurringEventList the recurring event list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRecurringEventQueryInspector
Description

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

Returnosid.calendaring.RecurringEventQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetRecurringEventSearchResultsRecord
Description

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

Parametersosid.type.TyperecurringEventSearchRecordType a recurring event search record type
Returnosid.calendaring.records.RecurringEventSearchResultsRecord the recurring event search results record
ErrorsNULL_ARGUMENT recurringEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(recurringEventSearchRecordType) is false
Compliancemandatory This method must be implemented.