Interface | osid.mapping.path.rules.SignalEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSignalEnablers | ||
Description |
Gets the | ||
Return | osid.mapping.path.rules.SignalEnablerList | the signal enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.mapping.path.rules.SignalEnablerQueryInspector | the signal enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSignalEnablerSearchResultsRecord | ||
Description |
Gets the signal enabler search results 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.SignalEnablerSearchResultsRecord | the signal enabler search results record | |
Errors | NULL_ARGUMENT | signalEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(signalEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |