OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.OffsetEventEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetOffsetEventEnablers
Description

Gets the OffsetEventEnablerList resulting from a search.

Returnosid.calendaring.rules.OffsetEventEnablerListthe offset event enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.calendaring.rules.OffsetEventEnablerQueryInspectorthe offset event enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventEnablerSearchResultsRecord
Description

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

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