OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.EventSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.EventSearchSession
Description

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

MethodgetEvents
Description

Gets the event list resulting from the search.

Returnosid.calendaring.EventList the event list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetEventQueryInspector
Description

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

Returnosid.calendaring.EventQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetEventSearchResultsRecord
Description

Gets the 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.TypeeventSearchRecordType an event search record type
Returnosid.calendaring.records.EventSearchResultsRecord the event search results record
ErrorsNULL_ARGUMENT eventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(eventSearchRecordType) is false
Compliancemandatory This method must be implemented.