Interface | osid.control.rules.InputEnablerSearchSession | ||
---|---|---|---|
Implements | osid.control.rules.InputEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getInputEnablerSearch | ||
Description |
Gets an input enabler search. | ||
Return | osid.control.rules.InputEnablerSearch | the input enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablerSearchOrder | ||
Description |
Gets an input enabler search order. The | ||
Return | osid.control.rules.InputEnablerSearchOrder | the input enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.control.rules.InputEnablerQuery | inputEnablerQuery | the input enabler query |
osid.control.rules.InputEnablerSearch | inputEnablerSearch | the input enabler search | |
Return | osid.control.rules.InputEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | inputEnablerQuery or inputEnablerSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inputEnablerQuery or inputEnablerSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablerQueryFromInspector | ||
Description |
Gets an input enabler query from an inspector. The
inspector is available from an | ||
Parameters | osid.control.rules.InputEnablerQueryInspector | inputEnablerQueryInspector | an input enabler query inspector |
Return | osid.control.rules.InputEnablerQuery | the input enabler query | |
Errors | NULL_ARGUMENT | inputEnablerQueryInspector is null | |
UNSUPPORTED | inputEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |