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

Interface	osid.workflow.rules.StepEnablerSearchSession
Implements	`osid.workflow.rules.StepEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepEnablers` . The search query is constructed using the `StepEnablerQuery` . `getStepEnablersByQuery()` is the basic search method and returns a list of `StepEnablers` . A more advanced search may be performed with `getStepEnablersBySearch()` .It accepts a `StepEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStepEnablersBySearch()` returns a `StepEnablerSearchResults` that can be used to access the resulting `StepEnablerList` or be used to perform a search within the result set through Ste `pEnablerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include step enablers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step enablers in this office Step enablers may have a query record indicated by their respective record types. The query record is accessed via the `StepEnablerQuery` .
Method	getStepEnablerSearch
Description	Gets a step enabler search.
Return	`osid.workflow.rules.StepEnablerSearch`		the step enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerSearchOrder
Description	Gets a step enabler search order. The `StepEnablerSearchOrder` is supplied to a `StepEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.StepEnablerSearchOrder`		the step enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.StepEnablerQuery`	`stepEnablerQuery`	the step enabler query
Parameters	`osid.workflow.rules.StepEnablerSearch`	`stepEnablerSearch`	the step enabler search
Return	`osid.workflow.rules.StepEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`stepEnablerQuery` or `stepEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepEnablerQuery` or `stepEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepEnablerQueryFromInspector
Description	Gets a step enabler query from an inspector. The inspector is available from a `StepEnablerSearchResults` .
Parameters	`osid.workflow.rules.StepEnablerQueryInspector`	`stepEnablerQueryInspector`	a step enabler query inspector
Return	`osid.workflow.rules.StepEnablerQuery`		the step enabler query
Errors	NULL_ARGUMENT		`stepEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.