OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.ActionEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.rules.ActionEnablerSearchSession
Description

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

MethodgetActionEnablers
Description

Gets the ActionEnablerList resulting from a search.

Returnosid.control.rules.ActionEnablerList the action enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetActionEnablerQueryInspector
Description

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

Returnosid.control.rules.ActionEnablerQueryInspector the action enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetActionEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeactionEnablerSearchRecordType an action enabler search record type
Returnosid.control.rules.records.ActionEnablerSearchResultsRecord the action enabler search results record
ErrorsNULL_ARGUMENT actionEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(actionEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.