public interface SignalSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
SignalList getSignals()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. SignalQueryInspector getSignalQueryInspector()
mandatory
- This method must be implemented. SignalSearchResultsRecord getSignalSearchResultsRecord(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.