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

Interface	osid.workflow.rules.ProcessConstrainerEnablerSearchSession
Implements	`osid.workflow.rules.ProcessConstrainerEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessConstrainerEnablers`. The search query is constructed using the `ProcessConstrainerEnablerQuery`. `getProcessConstrainerEnablersByQuery()` is the basic search method and returns a list of `ProcessConstrainerEnablers`. A more advanced search may be performed with `getProcessConstrainerEnablersBySearch()`.It accepts a `ProcessConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProcessConstrainerEnablersBySearch()` returns a `ProcessConstrainerEnablerSearchResults` that can be used to access the resulting `ProcessConstrainerEnablerList` or be used to perform a search within the result set through `ProcessConstrainerEnablerSearch`. This session defines views that offer differing behaviors for searching. federated office view: searches include process constrainer enablers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process constrainer enablers in this office Process constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `ProcessConstrainerEnablerQuery`.
Method	getProcessConstrainerEnablerSearch
Description	Gets a process constrainer enabler search.
Return	`osid.workflow.rules.ProcessConstrainerEnablerSearch`		the process constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerEnablerSearchOrder
Description	Gets a process constrainer enabler search order. The `ProcessConstrainerEnablerSearchOrder` is supplied to a `ProcessConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.ProcessConstrainerEnablerSearchOrder`		the process constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.ProcessEnablerQuery`	`processConstrainerEnablerQuery`	the process constrainer enabler query
Parameters	`osid.workflow.rules.ProcessConstrainerEnablerSearch`	`processConstrainerEnablerSearch`	the process constrainer enabler search
Return	`osid.workflow.rules.ProcessConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`processConstrainerEnablerQuery` or `processConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processConstrainerEnablerQuery` or `processConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessConstrainerEnablerQueryFromInspector
Description	Gets a process constrainer enabler query from an inspector. The inspector is available from a `ProcessConstrainerEnablerSearchResults`.
Parameters	`osid.workflow.rules.ProcessConstrainerEnablerQueryInspector`	`processConstrainerEnablerQueryInspector`	a process constrainer enabler query inspector
Return	`osid.workflow.rules.ProcessConstrainerEnablerQuery`		the process constrainer enabler query
Errors	NULL_ARGUMENT		`processConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`processConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.