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

The search interface for governing recurring event enabler searches.

MethodsearchAmongRecurringEventEnablers
Description

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

Parametersosid.id.IdListrecurringEventEnablerIdslist of recurring event enablers
ErrorsNULL_ARGUMENT recurringEventEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRecurringEventEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.rules.RecurringEventEnablerSearchOrderrecurringEventEnablerSearchOrderrecurring event enabler search order
ErrorsNULL_ARGUMENT recurringEventEnablerSearchOrder is null
UNSUPPORTED recurringEventEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventEnablerSearchRecord
Description

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

Parametersosid.type.TyperecurringEventEnablerSearchRecordTypea recurring event enabler search record type
Returnosid.calendaring.rules.records.RecurringEventEnablerSearchRecordthe recurring event enabler search record
ErrorsNULL_ARGUMENT recurringEventEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(recurringEventEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.