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

Interface	osid.workflow.rules.ProcessProcessorEnablerSearchSession
Implements	`osid.workflow.rules.ProcessProcessorEnablerQuerySession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessProcessorEnablers` . The search query is constructed using the `ProcessProcessorEnablerQuery` . `getProcessProcessorEnablersByQuery()` is the basic search method and returns a list of `ProcessProcessorEnablers` . A more advanced search may be performed with `getProcessProcessorEnablersBySearch()` .It accepts a `ProcessProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProcessProcessorEnablersBySearch()` returns a `ProcessProcessorEnablerSearchResults` that can be used to access the resulting `ProcessProcessorEnablerList` or be used to perform a search within the result set through `ProcessProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated office view: searches include process processor enablers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process processor enablers in this office Process processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `ProcessProcessorEnablerQuery` .
Method	getProcessProcessorEnablerSearch
Description	Gets a process processor enabler search.
Return	`osid.workflow.rules.ProcessProcessorEnablerSearch`		the process processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablerSearchOrder
Description	Gets a process processor enabler search order. The `ProcessProcessorEnablerSearchOrder` is supplied to a `ProcessProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.workflow.rules.ProcessProcessorEnablerSearchOrder`		the process processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.rules.ProcessProcessorEnablerQuery`	`processProcessorEnablerQuery`	the process processor enabler query
Parameters	`osid.workflow.rules.ProcessProcessorEnablerSearch`	`processProcessorEnablerSearch`	the process processor enabler search
Return	`osid.workflow.rules.ProcessProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`processProcessorEnablerQuery` or `processProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processProcessorEnablerQuery` or `processProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablerQueryFromInspector
Description	Gets a process processor enabler query from an inspector. The inspector is available from a `ProcessProcessorEnablerSearchResults` .
Parameters	`osid.workflow.rules.ProcessProcessorEnablerQueryInspector`	`processProcessorEnablerQueryInspector`	a process processor enabler query inspector
Return	`osid.workflow.rules.ProcessProcessorEnablerQuery`		the process processor enabler query
Errors	NULL_ARGUMENT		`processProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`processProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.