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

RecurringEventSearch defines the interface for specifying recurring event search options.

MethodsearchAmongRecurringEvents
Description

Execute this search among the given list of recurring events.

Parametersosid.id.IdListrecurringEventIdslist of recurring events
ErrorsNULL_ARGUMENT recurringEventIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRecurringEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.RecurringEventSearchOrderrecurringEventSearchOrderrecurring event search order
ErrorsNULL_ARGUMENT recurringEventSearchOrder is null
UNSUPPORTED recurringEventSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventSearchRecord
Description

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

Parametersosid.type.TyperecurringEventSearchRecordTypea recurring event search record type
Returnosid.calendaring.records.RecurringEventSearchRecordthe recurring event search record
ErrorsNULL_ARGUMENT recurringEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(recurringEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.