OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.SupersedingEventSearch
Implementsosid.OsidSearch
Description

SupersedingEventSearch defines the interface for specifying superseding event search options.

MethodsearchAmongSupersedingEvents
Description

Execute this search among the given list of superseding events.

Parametersosid.id.IdListsupersedingEventIdslist of superseding events
ErrorsNULL_ARGUMENT supersedingEventIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSupersedingEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.SupersedingEventSearchOrdersupersedingEventSearchOrdersuperseding event search order
ErrorsNULL_ARGUMENT supersedingEventSearchOrder is null
UNSUPPORTED superedingEventSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventSearchRecord
Description

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

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