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

Interface	osid.configuration.rules.ParameterProcessorSearchSession
Implements	`osid.configuration.rules.ParameterProcessorQuerySession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session provides methods for searching among `ParameterProcessor` objects. The search query is constructed using the `ParameterProcessoryQuery`. `getParameterProcessorsByQuery()` is the basic search method and returns a list of `ParameterProcessors`. A more advanced search may be performed with `getParameterProcessorsBySearch()`. It accepts a `ParameterProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. `getParameterProcessorsBySearch()` returns a `ParameterProcessorSearchResults` that can be used to access the resulting `ParameterProcessorList` or be used to perform a search within the result set through `ParameterProcessorSearch`. This session defines views that offer differing behaviors for searching. federated configuration view: searches include parameter processor in configurations of which this configuration is an ancestor in the configuration hierarchy isolated configuration view: searches are restricted to parameter processor in this configuration `ParameterProcessors` may have a query record indicated by their respective record types. The query record is accessed via the `ParameterProcessorQuery`.
Method	getParameterProcessorSearch
Description	Gets a parameter processor search.
Return	`osid.configuration.rules.ParameterProcessorSearch`		the parameter processor search
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorSearchOrder
Description	Gets a parameter processor search order. The `ParameterProcessorSearchOrder` is supplied to a `ParameterProcessorSearch` to specify the ordering of results.
Return	`osid.configuration.rules.ParameterProcessorSearchOrder`		the parameter processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.configuration.rules.ParameterProcessorQuery`	`parameterProcessorQuery`	the parameter processor query
Parameters	`osid.configuration.rules.ParameterProcessorSearch`	`parameterProcessorSearch`	the parameter processor search
Return	`osid.configuration.rules.ParameterProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`parameterProcessorQuery` or `parameterProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorQuery` or `parameterProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorQueryFromInspector
Description	Gets a parameter processor query from an inspector. The inspector is available from a `ParameterProcessorSearchResults`.
Parameters	`osid.configuration.rules.ParameterProcessorQueryInspector`	`parameterProcessorQueryInspector`	a parameter processor query inspector
Return	`osid.configuration.rules.ParameterProcessorQuery`		the parameter processor query
Errors	NULL_ARGUMENT		`parameterProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`parameterProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.