public interface SignalSearch extends OsidSearch
The search interface for governing signal searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSignals(IdList signalIds)
signalIds
- list of signalsNullArgumentException
- signalIds
is
null
mandatory
- This method must be implemented. void orderSignalResults(SignalSearchOrder signalSearchOrder)
signalSearchOrder
- signal search orderNullArgumentException
- signalSearchOrder
is null
UnsupportedException
- signalSearchOrder
is not of this servicemandatory
- This method must be implemented. SignalSearchRecord getSignalSearchRecord(Type signalSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.signalSearchRecordType
- a signal search record typeNullArgumentException
- signalSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalSearchRecordType)
is false
mandatory
- This method must be implemented.