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

EventSearch defines the interface for specifying event search options.

MethodsearchAmongCyclicEvents
Description

Execute this search among the given list of events.

Parametersosid.id.IdListcyclicEventIdslist of events
ErrorsNULL_ARGUMENT cyclicEventIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCyclicEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.cycle.CyclicEventSearchOrdercyclicEventSearchOrderevent search order
ErrorsNULL_ARGUMENT cyclicEventSearchOrder is null
UNSUPPORTED cyclicEventSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventSearchRecord
Description

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

Parametersosid.type.TypecyclicEventSearchRecordTypea cyclic event search record type
Returnosid.calendaring.cycle.records.CyclicEventSearchRecordthe cyclic event search record
ErrorsNULL_ARGUMENT cyclicEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.