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

EventSearch defines the interface for specifying event search options.

MethodsearchAmongEvents
Description

Execute this search among the given list of events.

Parametersosid.id.IdListeventIdslist of events
ErrorsNULL_ARGUMENT eventIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.EventSearchOrdereventSearchOrderevent search order
ErrorsNULL_ARGUMENT eventSearchOrder is null
UNSUPPORTED eventSearchOrder is not of this service
CompliancemandatoryThis 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.TypeeventSearchRecordTypean event search record type
Returnosid.calendaring.records.EventSearchRecordthe event search record
ErrorsNULL_ARGUMENT eventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(eventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.