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

Interface	osid.workflow.rules.StepProcessorEnablerSearchSession
Implements	`osid.workflow.rules.StepProcessorEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepProcessorEnabler` objects. The search query is constructed using the `StepProcessorEnableryQuery` . `getStepProcessorEnablersByQuery()` is the basic search method and returns a list of `StepProcessorEnablers` . A more advanced search may be performed with `getStepProcessorEnablersBySearch()` . It accepts a `StepProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. `getStepProcessorEnablersBySearch()` returns a `StepProcessorEnablerSearchResults` that can be used to access the resulting `StepProcessorEnablerList` or be used to perform a search within the result set through `StepProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include step processor enablers in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step processor enablers in this office `StepProcessorEnablers` may have a query record indicated by their respective query record types. The record is accessed via the `StepProcessorEnablerQuery` .
Method	getStepProcessorEnablerSearch
Description	Gets a step processor enabler search.
Return	`osid.workflow.rules.StepProcessorEnablerSearch`		the step processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablerSearchOrder
Description	Gets a step processor enabler search order. The `StepProcessorEnablerSearchOrder` is supplied to a `StepProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.StepProcessorEnablerSearchOrder`		the step processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.StepProcessorEnablerQuery`	`stepProcessorEnablerQuery`	the step processor enabler query
Parameters	`osid.workflow.rules.StepProcessorEnablerSearch`	`stepProcessorEnablerSearch`	the step processor enabler search
Return	`osid.workflow.rules.StepProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`stepProcessorEnablerQuery` or `stepProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepProcessorEnablerQuery` or `stepProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepProcessorEnablerQueryFromInspector
Description	Gets a step processor enabler query from an inspector. The inspector is available from a `StepProcessorEnablerSearchResults` .
Parameters	`osid.workflow.rules.StepProcessorEnablerQueryInspector`	`stepProcessorEnablerQueryInspector`	a step processor enabler query inspector
Return	`osid.workflow.rules.StepProcessorEnablerQuery`		the step processor enabler query
Errors	NULL_ARGUMENT		`stepProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.