OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.OffsetEventSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.OffsetEventSearchSession
Description

OffsetEventSearch defines the interface for specifying offset event search options.

MethodsearchAmongOffsetEvents
Description

Execute this search among the given list of offset events.

Parametersosid.id.IdListoffsetEventIds list of offset events
ErrorsNULL_ARGUMENT offsetEventIds is null
Compliancemandatory This method must be implemented.
MethodorderOffsetEventResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.OffsetEventSearchOrderoffsetEventSearchOrder offset event search order
ErrorsNULL_ARGUMENT offsetEventSearchOrder is null
UNSUPPORTED offsetEventSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetOffsetEventSearchRecord
Description

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

Parametersosid.type.TypeoffsetEventSearchRecordType an offset event search record type
Returnosid.calendaring.records.OffsetEventSearchRecord the offset event search record
ErrorsNULL_ARGUMENT offsetEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(offsetEventSearchRecordType) is false
Compliancemandatory This method must be implemented.