Interface SignalSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SignalSearch
extends OsidSearch

The search interface for governing signal searches.

Method Summary

Modifier and Type	Method	Description
SignalSearchRecord	getSignalSearchRecord(Type signalSearchRecordType)	Gets the record corresponding to the given signal search record Type .
void	orderSignalResults(SignalSearchOrder signalSearchOrder)	Specify an ordering to the search results.
void	searchAmongSignals(IdList signalIds)	Execute this search among the given list of signals.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongSignals

void searchAmongSignals(IdList signalIds)

Execute this search among the given list of signals.

Parameters:

signalIds - list of signals

Throws:

NullArgumentException - signalIds is null

Compliance:

mandatory - This method must be implemented.

orderSignalResults

void orderSignalResults(SignalSearchOrder signalSearchOrder)

Specify an ordering to the search results.

Parameters:

signalSearchOrder - signal search order

Throws:

NullArgumentException - signalSearchOrder is null

UnsupportedException - signalSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSignalSearchRecord

SignalSearchRecord getSignalSearchRecord(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 record

Throws:

NullArgumentException - signalSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.