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

Interface	osid.workflow.rules.StepProcessorSearchSession
Implements	`osid.workflow.rules.StepProcessorQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepProcessor` objects. The search query is constructed using the `StepProcessoryQuery` . `getStepProcessorsByQuery()` is the basic search method and returns a list of `StepProcessors` . A more advanced search may be performed with `getStepProcessorsBySearch()` .It accepts a `StepProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. `getStepProcessorsBySearch()` returns a `StepProcessorSearchResults` that can be used to access the resulting `StepProcessorList` or be used to perform a search within the result set through `StepProcessorSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include step processor in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step processor in this office `StepProcessors` may have a query record indicated by their respective record types. Thequery record is accessed via the `StepProcessorQuery` .
Method	getStepProcessorSearch
Description	Gets a step processor search.
Return	`osid.workflow.rules.StepProcessorSearch`		the step processor search
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorSearchOrder
Description	Gets a step processor search order. The `StepProcessorSearchOrder` is supplied to a `StepProcessorSearch` to specify the ordering of results.
Return	`osid.workflow.rules.StepProcessorSearchOrder`		the step processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.StepProcessorQuery`	`stepProcessorQuery`	the step processor query
Parameters	`osid.workflow.rules.StepProcessorSearch`	`stepProcessorSearch`	the step processor search
Return	`osid.workflow.rules.StepProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`stepProcessorQuery` or `stepProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepProcessorQuery` or `stepProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorQueryFromInspector
Description	Gets a step processor query from an inspector. The inspector is available from a `StepProcessorSearchResults` .
Parameters	`osid.workflow.rules.StepProcessorQueryInspector`	`stepProcessorQueryInspector`	a step processor query inspector
Return	`osid.workflow.rules.StepProcessorQuery`		the step processor query
Errors	NULL_ARGUMENT		`stepProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`stepProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.