OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SignalEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing signal enabler searches.

MethodsearchAmongSignalEnablers
Description

Execute this search among the given list of signal enablers.

Parametersosid.id.IdListmapIdslist of signal enablers
ErrorsNULL_ARGUMENT mapIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSignalEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.rules.SignalEnablerSearchOrdersignalEnablerSearchOrdersignal enabler search order
ErrorsNULL_ARGUMENT signalEnablerSearchOrder is null
UNSUPPORTED signalEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablerSearchRecord
Description

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

Parametersosid.type.TypesignalEnablerSearchRecordTypea signal enabler search record type
Returnosid.mapping.path.rules.records.SignalEnablerSearchRecordthe signal enabler search record
ErrorsNULL_ARGUMENT signalEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.