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

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

MethodgetSupersedingEvents
Description

Gets the superseding event list resulting from the search.

Returnosid.calendaring.SupersedingEventListthe superseding event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventQueryInspector
Description

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

Returnosid.calendaring.SupersedingEventQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventSearchResultsRecord
Description

Gets the superseding event search results record corresponding to the given superseding event search record Type.

Parametersosid.type.TypesupersedingEventSearchRecordTypea superseding event search record type
Returnosid.calendaring.records.SupersedingEventSearchResultsRecordthe superseding event search results record
ErrorsNULL_ARGUMENT supersedingEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(supersedingEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.