OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.RecurringEventSearchResults
Implementsosid.OsidSearchResults
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.RecurringEventListthe recurring event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventQueryInspector
Description

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

Returnosid.calendaring.RecurringEventQueryInspectorthe query inspector
CompliancemandatoryThis 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.TyperecurringEventSearchRecordTypea recurring event search record type
Returnosid.calendaring.records.RecurringEventSearchResultsRecordthe recurring event search results record
ErrorsNULL_ARGUMENT recurringEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(recurringEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.