Interface | osid.process.ProcessSearchSession | ||
---|---|---|---|
Implements | osid.process.ProcessQuerySession | ||
Description |
This session provides methods for searching among Processes may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getProcessSearch | ||
Description |
Gets a process search. | ||
Return | osid.process.ProcessSearch | the process search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessSearchOrder | ||
Description |
Gets a process search order. The | ||
Return | osid.process.ProcessSearchOrder | the process search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.process.ProcessQuery | processQuery | the process query |
osid.process.ProcessSearch | processSearch | the process search | |
Return | osid.process.ProcessSearchResults | the search results | |
Errors | NULL_ARGUMENT | processQuery or processSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | processQuery or processSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcessQueryFromInspector | ||
Description |
Gets a process query from an inspector. The inspector
is available from a | ||
Parameters | osid.process.ProcessQueryInspector | processQueryInspector | a proces query inspector |
Return | osid.process.ProcessQuery | the process query | |
Errors | NULL_ARGUMENT | processQueryInspector is null | |
UNSUPPORTED | processQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |