OSID - osid.lexicon.ParameterSearchSession Service Interface Definition

Interface	osid.lexicon.ParameterSearchSession
Implements	`osid.lexicon.ParameterQuerySession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session provides methods for searching among `Parameters` . The search query is constructed using the `ParameteryQuery` . `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` . This session defines views that offer differing behaviors for searching. federated press view: searches include parameters in presses of which this press is an ancestor in the press hierarchy isolated press view: searches are restricted to parameters in this press Parameters may have a parameter record indicated by their respective record types. The parameter record is accessed via the `ParameterQuery` .
Method	getParameterSearch
Description	Gets a parameter search.
Return	`osid.lexicon.ParameterSearch`		the parameter search
Compliance	`mandatory`		This method must be implemented.
Method	getParameterSearchOrder
Description	Gets a parameter search order. The `ParameterSearchOrder` is supplied to a `ParameterSearch` to specify the ordering of results.
Return	`osid.lexicon.ParameterSearchOrder`		the parameter search order
Compliance	`mandatory`		This method must be implemented.
Method	getParametersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.lexicon.ParameterQuery`	`parameterQuery`	the parameter query
Parameters	`osid.lexicon.ParameterSearch`	`parameterSearch`	the parameter search
Return	`osid.lexicon.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.lexicon.ParameterQueryInspector`	`parameterQueryInspector`	a parameter query inspector
Return	`osid.lexicon.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.