OSID - osid.configuration.ParameterSearchSession Service Interface Definition

Interface	osid.configuration.ParameterSearchSession
Implements	`osid.configuration.ParameterQuerySession`
Description	This session provides methods for searching `Parameter` objects. The search query is constructed using the `ParameterQuery.` `getParametersByQuery()` is the basic search method and returns a list of `Parameters.` A more advanced search may be performed with `getParametersBySearch().` It accepts a `ParameterSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getParametersBySearch()` returns a `ParameterSearchResults` that can be used to access the resulting `ParameterList` or be used to perform a search within the result set through `ParameterSearch.` Two views of the configuration data are defined; federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included isolated: parameters are contained to within this configuration
Method	getParameterSearch
Description	Gets a parameter search.
Return	`osid.configuration.ParameterSearch`		the parameter search
Compliance	`mandatory`		This method must be implemented.
Method	getParameterSearchOrder
Description	Gets a parameter entry search order. The `ParameterEntrySearchOrder` is supplied to an `ParameterEntrySearch` to specify the ordering of results.
Return	`osid.configuration.ParameterSearchOrder`		the parameter search order
Compliance	`mandatory`		This method must be implemented.
Method	getParametersBySearch
Description	Gets a list of `Parameters` matching the given search query using the given search.
Parameters	`osid.configuration.ParameterQuery`	`parameterQuery`	the parameter query
Parameters	`osid.configuration.ParameterSearch`	`parameterSearch`	the parameter search
Return	`osid.configuration.ParameterSearchResults`		the parameter search results
Errors	NULL_ARGUMENT		`parameterQuery` or `parameterSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterQuery` or `parameterSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQueryFromInspector
Description	Gets a parameter query from an inspector. The inspector is available from a `ParameterSearchResults.`
Parameters	`osid.configuration.ParameterQueryInspector`	`parameterQueryInspector`	a parameter query inspector
Return	`osid.configuration.ParameterQuery`		the parameter query
Errors	NULL_ARGUMENT		`parameterQueryInspector` is `null`
Errors	UNSUPPORTED		`parameterQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.