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

The search interface for governing signal searches.

MethodsearchAmongSignals
Description

Execute this search among the given list of signals.

Parametersosid.id.IdListsignalIdslist of signals
ErrorsNULL_ARGUMENT signalIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSignalResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.SignalSearchOrdersignalSearchOrdersignal search order
ErrorsNULL_ARGUMENT signalSearchOrder is null
UNSUPPORTED signalSearchOrder is not of this service
CompliancemandatoryThis 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.TypesignalSearchRecordTypea signal search record type
Returnosid.mapping.path.records.SignalSearchRecordthe signal search record
ErrorsNULL_ARGUMENT signalSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalSearchRecordType) is false
CompliancemandatoryThis method must be implemented.