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

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

MethodgetEvents
Description

Gets the event list resulting from the search.

Returnosid.calendaring.EventListthe event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetEventQueryInspector
Description

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

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