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

The search interface for governing superseding event enabler searches.

MethodsearchAmongSupersedingEventEnablers
Description

Execute this search among the given list of superseding event enablers.

Parametersosid.id.IdListsupersedingEventEnablerIdslist of superseding event enablers
ErrorsNULL_ARGUMENT supersedingEventEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSupersedingEventEnablerResults
Description

Specify a superseding event ordering to the search results.

Parametersosid.calendaring.rules.SupersedingEventEnablerSearchOrdersupersedingEventEnablerSearchOrdersuperseding event enabler search order
ErrorsNULL_ARGUMENT supersdeingEventEnablerSearchOrder is null
UNSUPPORTED supersedingEventEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablerSearchRecord
Description

Gets the superseding event enabler search record corresponding to the given superseding event enabler search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypesupersedingEventEnablerSearchRecordTypea superseding event enabler search record type
Returnosid.calendaring.rules.records.SupersedingEventEnablerSearchRecordthe superseding event enabler search record
ErrorsNULL_ARGUMENT supersedingEventEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(supersedingEventEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.