OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.RecurringEventSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.RecurringEventSearchSession
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.IdListrecurringEventIds list of recurring events
ErrorsNULL_ARGUMENT recurringEventIds is null
Compliancemandatory This method must be implemented.
MethodorderRecurringEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.RecurringEventSearchOrderrecurringEventSearchOrder recurring event search order
ErrorsNULL_ARGUMENT recurringEventSearchOrder is null
UNSUPPORTED recurringEventSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRecurringEventSearchRecord
Description

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

Parametersosid.type.TyperecurringEventSearchRecordType a recurring event search record type
Returnosid.calendaring.records.RecurringEventSearchRecord the recurring event search record
ErrorsNULL_ARGUMENT recurringEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(recurringEventSearchRecordType) is false
Compliancemandatory This method must be implemented.