OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.OffsetEventEnablerSearch
Implementsosid.OsidSearch
Used Byosid.calendaring.rules.OffsetEventEnablerSearchSession
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.IdListoffsetEventEnablerIds list of offset event enablers
ErrorsNULL_ARGUMENT offsetEventEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderOffsetEventEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.rules.OffsetEventEnablerSearchOrderoffsetEventEnablerSearchOrder offset event enabler search order
ErrorsNULL_ARGUMENT offsetEventEnablerSearchOrder is null
UNSUPPORTED offsetEventEnablerSearchOrder is not of this service
Compliancemandatory This 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.TypeoffsetEventEnablerSearchRecordType an offset event enabler search record type
Returnosid.calendaring.rules.records.OffsetEventEnablerSearchRecord the offset event enabler search record
ErrorsNULL_ARGUMENT offsetEventEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(offsetEventEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.