OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.SignalSearch
Implementsosid.OsidSearch
Used Byosid.mapping.path.SignalSearchSession
Description

The search interface for governing signal searches.

MethodsearchAmongSignals
Description

Execute this search among the given list of signals.

Parametersosid.id.IdListsignalIds list of signals
ErrorsNULL_ARGUMENT signalIds is null
Compliancemandatory This method must be implemented.
MethodorderSignalResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.SignalSearchOrdersignalSearchOrder signal search order
ErrorsNULL_ARGUMENT signalSearchOrder is null
UNSUPPORTED signalSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSignalSearchRecord
Description

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

Parametersosid.type.TypesignalSearchRecordType a signal search record type
Returnosid.mapping.path.records.SignalSearchRecord the signal search record
ErrorsNULL_ARGUMENT signalSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(signalSearchRecordType) is false
Compliancemandatory This method must be implemented.