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

Interface	osid.workflow.rules.ProcessEnablerSearchSession
Implements	`osid.workflow.rules.ProcessEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessEnabler` objects. The search query is constructed using the `ProcessEnableryQuery` . `getProcessEnablersByQuery()` is the basic search method and returns a list of `ProcessEnablers` . A more advanced search may be performed with `getProcessEnablersBySearch()` . It accepts a `ProcessEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. `getProcessEnablersBySearch()` returns a `ProcessEnablerSearchResults` that can be used to access the resulting `ProcessEnablerList` or be used to perform a search within the result set through `ProcessEnablerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include process enabler in office of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process enabler in this office `ProcessEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ProcessEnablerQuery` .
Method	getProcessEnablerSearch
Description	Gets a process enabler search.
Return	`osid.workflow.rules.ProcessEnablerSearch`		the process enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablerSearchOrder
Description	Gets a process enabler search order. The `ProcessEnablerSearchOrder` is supplied to a `ProcessEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.ProcessEnablerSearchOrder`		the process enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.ProcessEnablerQuery`	`processEnablerQuery`	the process enabler query
Parameters	`osid.workflow.rules.ProcessEnablerSearch`	`processEnablerSearch`	the process enabler search
Return	`osid.workflow.rules.ProcessEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`processEnablerQuery` or `processEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processEnablerQuery` or `processEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablerQueryFromInspector
Description	Gets a process enabler query from an inspector. The inspector is available from a `ProcessEnablerSearchResults` .
Parameters	`osid.workflow.rules.ProcessEnablerQueryInspector`	`processEnablerQueryInspector`	a process enabler query inspector
Return	`osid.workflow.rules.ProcessEnablerQuery`		the process enabler query
Errors	NULL_ARGUMENT		`processEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`processEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.