| Interface | osid.process.ProcessSearchSession | ||
|---|---|---|---|
| Implements | osid.process.ProcessQuerySession | ||
| Used By | osid.process.ProcessManager | ||
osid.process.ProcessProxyManager | |||
| Description |
This session provides methods for searching among
getProcessesByQuery() is the basic search method
and returns a list of Process objects.A more
advanced search may be performed with
getProcessesBySearch().It accepts a
ProcessSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getProcessesBySearch()
returns a ProcessSearchResults that can be used
to access the resulting ProcessList or be used to
perform a search within the result set through
ProcessSearch.
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. | |