Interface | osid.mapping.path.SignalSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSignals | ||
Description |
Gets the signal list resulting from a search. | ||
Return | osid.mapping.path.SignalList | the signal list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSignalQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.mapping.path.SignalQueryInspector | the signal query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSignalSearchResultsRecord | ||
Description |
Gets the record corresponding to the given signal
search record | ||
Parameters | osid.type.Type | signalSearchRecordType | a signal search record type |
Return | osid.mapping.path.records.SignalSearchResultsRecord | the signal search results record | |
Errors | NULL_ARGUMENT | signalSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(signalSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |