OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SignalSearchResults
Implementsosid.OsidSearchResults
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.SignalListthe signal list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSignalQueryInspector
Description

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

Returnosid.mapping.path.SignalQueryInspectorthe signal query inspector
CompliancemandatoryThis 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.TypesignalSearchRecordTypea signal search record type
Returnosid.mapping.path.records.SignalSearchResultsRecordthe signal search results record
ErrorsNULL_ARGUMENT signalSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalSearchRecordType) is false
CompliancemandatoryThis method must be implemented.