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

Interface	osid.workflow.rules.StepConstrainerSearchSession
Implements	`osid.workflow.rules.StepConstrainerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `StepConstrainer` objects. The search query is constructed using the `StepConstraineryQuery` . `getStepConstrainersByQuery()` is the basic search method and returns a list of `StepConstrainers` . A more advanced search may be performed with `getStepConstrainersBySearch()` . It accepts a `StepConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. `getStepConstrainersBySearch()` returns a `StepConstrainerSearchResults` that can be used to access the resulting `StepConstrainerList` or be used to perform a search within the result set through `StepConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include step constrainer in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to step constrainer in this office `StepConstrainers` may have a query record indicated by their respective record types. The query record is accessed via the `StepConstrainerQuery` .
Method	getStepConstrainerSearch
Description	Gets a step constrainer search.
Return	`osid.workflow.rules.StepConstrainerSearch`		the step constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerSearchOrder
Description	Gets a step constrainer search order. The `StepConstrainerSearchOrder` is supplied to a `StepConstrainerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.StepConstrainerSearchOrder`		the step constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.StepConstrainerQuery`	`stepConstrainerQuery`	the step constrainer query
Parameters	`osid.workflow.rules.StepConstrainerSearch`	`stepConstrainerSearch`	the step constrainer search
Return	`osid.workflow.rules.StepConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`stepConstrainerQuery` or `stepConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stepConstrainerQuery` or `stepConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepConstrainerQueryFromInspector
Description	Gets a step constrainer query from an inspector. The inspector is available from a `StepConstrainerSearchResults` .
Parameters	`osid.workflow.rules.StepConstrainerQueryInspector`	`stepConstrainerQueryInspector`	a step constrainer query inspector
Return	`osid.workflow.rules.StepConstrainerQuery`		the step constrainer query
Errors	NULL_ARGUMENT		`stepConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`stepConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.