Interface | osid.workflow.rules.ProcessEnablerSearchSession | ||
---|---|---|---|
Implements | osid.workflow.rules.ProcessEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getProcessEnablerSearch | ||
Description |
Gets a process enabler search. | ||
Return | osid.workflow.rules.ProcessEnablerSearch | the process enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessEnablerSearchOrder | ||
Description |
Gets a process enabler search order. The | ||
Return | osid.workflow.rules.ProcessEnablerSearchOrder | the process enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.workflow.rules.ProcessEnablerQuery | processEnablerQuery | the process enabler query |
osid.workflow.rules.ProcessEnablerSearch | processEnablerSearch | the process enabler search | |
Return | osid.workflow.rules.ProcessEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | processEnablerQuery or processEnablerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | processEnablerQuery or processEnablerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessEnablerQueryFromInspector | ||
Description |
Gets a process enabler query from an inspector. The
inspector is available from a | ||
Parameters | osid.workflow.rules.ProcessEnablerQueryInspector | processEnablerQueryInspector | a process enabler query inspector |
Return | osid.workflow.rules.ProcessEnablerQuery | the process enabler query | |
Errors | NULL_ARGUMENT | processEnablerQueryInspector is null | |
UNSUPPORTED | processEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |