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

Interface	osid.workflow.rules.StepConstrainerEnablerSearchSession
Implements	`osid.workflow.rules.StepConstrainerEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepConstrainerEnabler` objects. The search query is constructed using the `StepConstrainerEnableryQuery` . `getStepConstrainerEnablersByQuery()` is the basic search method and returns a list of `StepConstrainerEnablers` . A more advanced search may be performed with `getStepConstrainerEnablersBySearch()` .It accepts a `StepConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. `getStepConstrainerEnablersBySearch()` returns a `StepConstrainerEnablerSearchResults` that can be used to access the resulting `StepConstrainerEnablerList` or be used to perform a search within the result set through `StepConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include step constrainer enablers in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step constrainer enablers in this office `StepConstrainerEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `StepConstrainerEnablerQuery` .
Method	getStepConstrainerEnablerSearch
Description	Gets a step constrainer enabler search.
Return	`osid.workflow.rules.StepConstrainerEnablerSearch`		the step constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablerSearchOrder
Description	Gets a step constrainer enabler search order. The `StepConstrainerEnablerSearchOrder` is supplied to a `StepConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.StepConstrainerEnablerSearchOrder`		the step constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.StepConstrainerEnablerQuery`	`stepConstrainerEnablerQuery`	the step constrainer enabler query
Parameters	`osid.workflow.rules.StepConstrainerEnablerSearch`	`stepConstrainerEnablerSearch`	the step constrainer enabler search
Return	`osid.workflow.rules.StepConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`stepConstrainerEnablerQuery` or `stepConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepConstrainerEnablerQuery` or `stepConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerEnablerQueryFromInspector
Description	Gets a step constrainer enabler query from an inspector. The inspector is available from a `StepConstrainerEnablerSearchResults` .
Parameters	`osid.workflow.rules.StepConstrainerEnablerQueryInspector`	`stepConstrainerEnablerQueryInspector`	a step constrainer enabler query inspector
Return	`osid.workflow.rules.StepConstrainerEnablerQuery`		the step constrainer enabler query
Errors	NULL_ARGUMENT		`stepConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.