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

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

MethodgetActionEnablers
Description

Gets the ActionEnablerList resulting from a search.

Returnosid.control.rules.ActionEnablerListthe action enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerQueryInspector
Description

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

Returnosid.control.rules.ActionEnablerQueryInspectorthe action enabler query inspector
CompliancemandatoryThis 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.TypeactionEnablerSearchRecordTypean action enabler search record type
Returnosid.control.rules.records.ActionEnablerSearchResultsRecordthe action enabler search results record
ErrorsNULL_ARGUMENT actionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(actionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.