Interface | osid.control.rules.ActionEnablerSearchSession | ||
---|---|---|---|
Implements | osid.control.rules.ActionEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getActionEnablerSearch | ||
Description |
Gets an action enabler search. | ||
Return | osid.control.rules.ActionEnablerSearch | the action enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerSearchOrder | ||
Description |
Gets an action enabler search order. The | ||
Return | osid.control.rules.ActionEnablerSearchOrder | the action enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.control.rules.ActionEnablerQuery | actionEnablerQuery | the action enabler query |
osid.control.rules.ActionEnablerSearch | actionEnablerSearch | the action enabler search | |
Return | osid.control.rules.ActionEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | actionEnablerQuery or actionEnablerSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionEnablerQuery or actionEnablerSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerQueryFromInspector | ||
Description |
Gets an action enabler query from an inspector. The
inspector is available from an | ||
Parameters | osid.control.rules.ActionEnablerQueryInspector | actionEnablerQueryInspector | an action enabler query inspector |
Return | osid.control.rules.ActionEnablerQuery | the action enabler query | |
Errors | NULL_ARGUMENT | actionEnablerQueryInspector is null | |
UNSUPPORTED | actionEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |