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

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

MethodgetCyclicEvents
Description

Gets the cyclic event list resulting from the search.

Returnosid.calendaring.cycle.CyclicEventListthe cyclic event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventQueryInspector
Description

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

Returnosid.calendaring.cycle.CyclicEventQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventSearchResultsRecord
Description

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

Parametersosid.type.TypecyclicEventSearchRecordTypea cyclic event search record type
Returnosid.calendaring.cycle.records.CyclicEventSearchResultsRecordthe cyclic event search results record
ErrorsNULL_ARGUMENT cyclicEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.