OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicEventSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.cycle.CyclicEventSearchSession
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.CyclicEventList the cyclic event list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCyclicEventQueryInspector
Description

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

Returnosid.calendaring.cycle.CyclicEventQueryInspector the query inspector
Compliancemandatory This 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.TypecyclicEventSearchRecordType a cyclic event search record type
Returnosid.calendaring.cycle.records.CyclicEventSearchResultsRecord the cyclic event search results record
ErrorsNULL_ARGUMENT cyclicEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cyclicEventSearchRecordType) is false
Compliancemandatory This method must be implemented.