OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.SupersedingEventSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.SupersedingEventSearchSession
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.IdListsupersedingEventIds list of superseding events
ErrorsNULL_ARGUMENT supersedingEventIds is null
Compliancemandatory This method must be implemented.
MethodorderSupersedingEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.SupersedingEventSearchOrdersupersedingEventSearchOrder superseding event search order
ErrorsNULL_ARGUMENT supersedingEventSearchOrder is null
UNSUPPORTED superedingEventSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSupersedingEventSearchRecord
Description

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

Parametersosid.type.TypesupersedingEventSearchRecordType a superseding event search record type
Returnosid.calendaring.records.SupersedingEventSearchRecord the superseding event search record
ErrorsNULL_ARGUMENT supersedingEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(supersedingEventSearchRecordType) is false
Compliancemandatory This method must be implemented.