OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.SignalEnablerSearch
Implementsosid.OsidSearch
Used Byosid.mapping.path.rules.SignalEnablerSearchSession
Description

The search interface for governing signal enabler searches.

MethodsearchAmongSignalEnablers
Description

Execute this search among the given list of signal enablers.

Parametersosid.id.IdListmapIds list of signal enablers
ErrorsNULL_ARGUMENT mapIds is null
Compliancemandatory This method must be implemented.
MethodorderSignalEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.rules.SignalEnablerSearchOrdersignalEnablerSearchOrder signal enabler search order
ErrorsNULL_ARGUMENT signalEnablerSearchOrder is null
UNSUPPORTED signalEnablerSearchOrder is not of this service
Compliancemandatory This 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.TypesignalEnablerSearchRecordType a signal enabler search record type
Returnosid.mapping.path.rules.records.SignalEnablerSearchRecord the signal enabler search record
ErrorsNULL_ARGUMENT signalEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(signalEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.