org.osid.mapping.path

Interface SignalSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SignalSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
SignalQueryInspector	getSignalQueryInspector() Gets the inspector for the query to examine the terms used in the search.
SignalList	getSignals() Gets the signal list resulting from a search.
SignalSearchResultsRecord	getSignalSearchResultsRecord(Type signalSearchRecordType) Gets the record corresponding to the given signal search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getSignals

SignalList getSignals()

Gets the signal list resulting from a search.

Returns:

the signal list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSignalQueryInspector

SignalQueryInspector getSignalQueryInspector()

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

Returns:

the signal query inspector

Compliance:

mandatory - This method must be implemented.

getSignalSearchResultsRecord

SignalSearchResultsRecord getSignalSearchResultsRecord(Type signalSearchRecordType)
                                                       throws OperationFailedException

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

Parameters:

signalSearchRecordType - a signal search record type

Returns:

the signal search results record

Throws:

NullArgumentException - signalSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.