OSID - osid.workflow.ProcessSearchSession Service Interface Definition

Interface	osid.workflow.ProcessSearchSession
Implements	`osid.workflow.ProcessQuerySession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session provides methods for searching among `Processes` . The search query is constructed using the `ProcessQuery` . `getProcesssByQuery()` is the basic search method and returns a list of `Processes` . 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` . This session defines views that offer differing behaviors for searching. federated office view: searches include processes in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to processes in this office Processes may have a query record indicated by their respective record types. The query record is accessed via the `ProcessQuery` .
Method	getProcessSearch
Description	Gets a process search.
Return	`osid.workflow.ProcessSearch`		the process search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessSearchOrder
Description	Gets a process search order. The `ProcessSearchOrder` is supplied to a `ProcessSearch` to specify the ordering of results.
Return	`osid.workflow.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.workflow.ProcessQuery`	`processQuery`	the process query
Parameters	`osid.workflow.ProcessSearch`	`processSearch`	the process search
Return	`osid.workflow.ProcessSearchResults`		the process 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 `ProcessSearchResults` .
Parameters	`osid.workflow.ProcessQueryInspector`	`processQueryInspector`	a process query inspector
Return	`osid.workflow.ProcessQuery`		the process query
Errors	NULL_ARGUMENT		`processQueryInspector` is `null`
Errors	UNSUPPORTED		`processQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.