OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.SignalSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.path.SignalSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetSignals
Description

Gets the signal list resulting from a search.

Returnosid.mapping.path.SignalList the signal list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetSignalQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.mapping.path.SignalQueryInspector the signal query inspector
Compliancemandatory This method must be implemented.
MethodgetSignalSearchResultsRecord
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.SignalSearchResultsRecord the signal search results record
ErrorsNULL_ARGUMENT signalSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(signalSearchRecordType) is false
Compliancemandatory This method must be implemented.