OSID - osid.workflow.rules.ProcessProcessorSearchSession Service Interface Definition

Interface	osid.workflow.rules.ProcessProcessorSearchSession
Implements	`osid.workflow.rules.ProcessProcessorQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessProcessors` . The search query is constructed using the `ProcessProcessorQuery` . `getProcessProcessorsByQuery()` is the basic search method and returns a list of `ProcessProcessors` . A more advanced search may be performed with `getProcessProcessorsBySearch()` . It accepts a `ProcessProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProcessProcessorsBySearch()` returns a `ProcessProcessorSearchResults` that can be used to access the resulting `ProcessProcessorList` or be used to perform a search within the result set through `ProcessProcessorSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include process processors in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process processors in this office Process processors may have a query record indicated by their respective record types. The query record is accessed via the `ProcessProcessorQuery` .
Method	getProcessProcessorSearch
Description	Gets a process processor search.
Return	`osid.workflow.rules.ProcessProcessorSearch`		the process processor search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorSearchOrder
Description	Gets a process processor search order. The `ProcessProcessorSearchOrder` is supplied to a `ProcessProcessorSearch` to specify the ordering of results.
Return	`osid.workflow.rules.ProcessProcessorSearchOrder`		the process processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.ProcessProcessorQuery`	`processProcessorQuery`	the process processor query
Parameters	`osid.workflow.rules.ProcessProcessorSearch`	`processProcessorSearch`	the process processor search
Return	`osid.workflow.rules.ProcessProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`processProcessorQuery` or `processProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processProcessorQuery` or `processProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorQueryFromInspector
Description	Gets a process processor query from an inspector. The inspector is available from a `ProcessProcessorSearchResults` .
Parameters	`osid.workflow.rules.ProcessProcessorQueryInspector`	`processProcessorQueryInspector`	a process processor query inspector
Return	`osid.workflow.rules.ProcessProcessorQuery`		the process processor query
Errors	NULL_ARGUMENT		`processProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`processProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.