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

The search interface for governing input enabler searches.

MethodsearchAmongInputEnablers
Description

Execute this search among the given list of input enablers.

Parametersosid.id.IdListinputEnablerIdslist of input enablers
ErrorsNULL_ARGUMENT inputEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInputEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.control.rules.InputEnablerSearchOrderinputEnablerSearchOrderinput enabler search order
ErrorsNULL_ARGUMENT inputEnablerSearchOrder is null
UNSUPPORTED inputEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerSearchRecord
Description

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

Parametersosid.type.TypeinputEnablerSearchRecordTypean input enabler search record type
Returnosid.control.rules.records.InputEnablerSearchRecordthe input enabler search record
ErrorsNULL_ARGUMENT inputEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.