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

The search interface for governing offset event enabler searches.

MethodsearchAmongOffsetEventEnablers
Description

Execute this search among the given list of offset event enablers.

Parametersosid.id.IdListoffsetEventEnablerIdslist of offset event enablers
ErrorsNULL_ARGUMENT offsetEventEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOffsetEventEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.rules.OffsetEventEnablerSearchOrderoffsetEventEnablerSearchOrderoffset event enabler search order
ErrorsNULL_ARGUMENT offsetEventEnablerSearchOrder is null
UNSUPPORTED offsetEventEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablerSearchRecord
Description

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

Parametersosid.type.TypeoffsetEventEnablerSearchRecordTypean offset event enabler search record type
Returnosid.calendaring.rules.records.OffsetEventEnablerSearchRecordthe offset event enabler search record
ErrorsNULL_ARGUMENT offsetEventEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offsetEventEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.