OSID - osid.configuration.ValueSearchSession Service Interface Definition

Interface	osid.configuration.ValueSearchSession
Implements	`osid.configuration.ValueQuerySession`
Description	This session provides methods for searching `Value` objects. The search query is constructed using the `ValueQuery.` The parameter `Type` also specifies the record for the value query. `getValuesByQuery()` is the basic search method and returns a list of `Values.` A more advanced search may be performed with `getValuesBySearch().` It accepts a `ValueSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getValuesBySearch()` returns a `ValueSearchResults` that can be used to access the resulting `ValueList` or be used to perform a search within the result set through `ValueSearch.` Two views of the configuration data are defined; federated: values defined in configurations that are a parent of this configuration in the configuration hierarchy are included isolated: values are contained to within this configuration
Method	getValueSearch
Description	Gets a value search.
Return	`osid.configuration.ValueSearch`		the value search
Compliance	`mandatory`		This method must be implemented.
Method	getValueSearchOrder
Description	Gets a value search order. The `ValueSearchOrder` is supplied to a `ValueSearch` to specify the ordering of results.
Return	`osid.configuration.ValueSearchOrder`		the value search order
Compliance	`mandatory`		This method must be implemented.
Method	getValuesBySearch
Description	Gets a list of `Values` matching the given search query using the given search.
Parameters	`osid.configuration.ValueQuery`	`valueQuery`	the value query
Parameters	`osid.configuration.ValueSearch`	`valueSearch`	the value search
Return	`osid.configuration.ValueSearchResults`		the serach results
Errors	NULL_ARGUMENT		`valueQuery` or `valueSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueQuery` or `valueSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getValueQueryFromInspector
Description	Gets a value query from an inspector. The inspector is available from a `ValueSearchResults.`
Parameters	`osid.configuration.ValueQueryInspector`	`valueQueryInspector`	a value query inspector
Return	`osid.configuration.ValueQuery`		the value query
Errors	NULL_ARGUMENT		`valueQueryInspector` is `null`
Errors	UNSUPPORTED		`valueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.