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

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

MethodgetRecurringEventEnablers
Description

Gets the RecurringEventEnablerList resulting from a search.

Returnosid.calendaring.rules.RecurringEventEnablerListthe recurring event enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventEnablerQueryInspector
Description

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

Returnosid.calendaring.rules.RecurringEventEnablerQueryInspectorthe recurring event enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventEnablerSearchResultsRecord
Description

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

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