Interface | osid.mapping.path.rules.SignalEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing signal enabler searches. | ||
Method | searchAmongSignalEnablers | ||
Description |
Execute this search among the given list of signal enablers. | ||
Parameters | osid.id.IdList | mapIds | list of signal enablers |
Errors | NULL_ARGUMENT | mapIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderSignalEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.mapping.path.rules.SignalEnablerSearchOrder | signalEnablerSearchOrder | signal enabler search order |
Errors | NULL_ARGUMENT | signalEnablerSearchOrder is null | |
UNSUPPORTED | signalEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablerSearchRecord | ||
Description |
Gets the signal enabler search record corresponding to
the given signal enabler search record | ||
Parameters | osid.type.Type | signalEnablerSearchRecordType | a signal enabler search record type |
Return | osid.mapping.path.rules.records.SignalEnablerSearchRecord | the signal enabler search record | |
Errors | NULL_ARGUMENT | signalEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(signalEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |