Interface | osid.mapping.path.SignalSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing signal searches. | ||
Method | searchAmongSignals | ||
Description |
Execute this search among the given list of signals. | ||
Parameters | osid.id.IdList | signalIds | list of signals |
Errors | NULL_ARGUMENT | signalIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderSignalResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.mapping.path.SignalSearchOrder | signalSearchOrder | signal search order |
Errors | NULL_ARGUMENT | signalSearchOrder is null | |
UNSUPPORTED | signalSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalSearchRecord | ||
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.SignalSearchRecord | the signal search 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. |