OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.TriggerEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetTriggerEnablers
Description

Gets the TriggerEnablerList resulting from a search.

Returnosid.control.rules.TriggerEnablerListthe trigger enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablerQueryInspector
Description

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

Returnosid.control.rules.TriggerEnablerQueryInspectorthe trigger enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypetriggerEnablerSearchRecordTypea trigger enabler search record type
Returnosid.control.rules.records.TriggerEnablerSearchResultsRecordthe trigger enabler search results record
ErrorsNULL_ARGUMENT triggerEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(triggerEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.