OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.ActionEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing action enabler searches.

MethodsearchAmongActionEnablers
Description

Execute this search among the given list of action enablers.

Parametersosid.id.IdListactionEnablerIdslist of action enablers
ErrorsNULL_ARGUMENT actionEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActionEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.control.rules.ActionEnablerSearchOrderactionEnablerSearchOrderaction enabler search order
ErrorsNULL_ARGUMENT actionEnablerSearchOrder is null
UNSUPPORTED actionEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerSearchRecord
Description

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

Parametersosid.type.TypeactionEnablerSearchRecordTypean action enabler search record type
Returnosid.control.rules.records.ActionEnablerSearchRecordthe action enabler search record
ErrorsNULL_ARGUMENT actionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(actionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.