OSID - osid.configuration.rules.ParameterProcessorEnablerSearchSession Service Interface Definition

Interface	osid.configuration.rules.ParameterProcessorEnablerSearchSession
Implements	`osid.configuration.rules.ParameterProcessorEnablerQuerySession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session provides methods for searching among `ParameterProcessorEnabler` objects. The search query is constructed using the `ParameterProcessorEnableryQuery`. `getParameterProcessorEnablersByQuery()` is the basic search method and returns a list of `ParameterProcessorEnablers`. A more advanced search may be performed with `getParameterProcessorEnablersBySearch()`.It accepts a `ParameterProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. `getParameterProcessorEnablersBySearch()` returns a `ParameterProcessorEnablerSearchResults` that can be used to access the resulting `ParameterProcessorEnablerList` or be used to perform a search within the result set through `ParameterProcessorEnablerSearch`. This session defines views that offer differing behaviors for searching. federated configuration view: searches include parameter processor enablers in configurations of which this configuration is an ancestor in the configuration hierarchy isolated configuration view: searches are restricted to parameter processor enablers in this configuration `ParameterProcessorEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ParameterProcessorEnablerQuery`.
Method	getParameterProcessorEnablerSearch
Description	Gets a parameter processor enabler search.
Return	`osid.configuration.rules.ParameterProcessorEnablerSearch`		the parameter processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablerSearchOrder
Description	Gets a parameter processor enabler search order. The `ParameterProcessorEnablerSearchOrder` is supplied to a `ParameterProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.configuration.rules.ParameterProcessorEnablerSearchOrder`		the parameter processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.configuration.rules.ParameterProcessorEnablerQuery`	`parameterProcessorEnablerQuery`	the parameter processor enabler query
Parameters	`osid.configuration.rules.ParameterProcessorEnablerSearch`	`parameterProcessorEnablerSearch`	the parameter processor enabler search
Return	`osid.configuration.rules.ParameterProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`parameterProcessorEnablerQuery` or `parameterProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorEnablerQuery` or `parameterProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablerQueryFromInspector
Description	Gets a parameter processor enabler query from an inspector. The inspector is available from a `ParameterProcessorEnablerSearchResults`.
Parameters	`osid.configuration.rules.ParameterProcessorEnablerQueryInspector`	`parameterProcessorEnablerQueryInspector`	a parameter processor enabler query inspector
Return	`osid.configuration.rules.ParameterProcessorEnablerQuery`		the parameter processor enabler query
Errors	NULL_ARGUMENT		`parameterProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`parameterProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.