OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.EventSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.EventSearchSession
Description

EventSearch defines the interface for specifying event search options.

MethodsearchAmongEvents
Description

Execute this search among the given list of events.

Parametersosid.id.IdListeventIds list of events
ErrorsNULL_ARGUMENT eventIds is null
Compliancemandatory This method must be implemented.
MethodorderEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.EventSearchOrdereventSearchOrder event search order
ErrorsNULL_ARGUMENT eventSearchOrder is null
UNSUPPORTED eventSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetEventSearchRecord
Description

Gets the 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.TypeeventSearchRecordType an event search record type
Returnosid.calendaring.records.EventSearchRecord the event search record
ErrorsNULL_ARGUMENT eventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(eventSearchRecordType) is false
Compliancemandatory This method must be implemented.