OSID - osid.control.SettingSearchSession Service Interface Definition

Interface	osid.control.SettingSearchSession
Implements	`osid.control.SettingQuerySession`
Description	This session provides methods for searching among `Setting` objects. The search query is constructed using the `SettingQuery.` `getSettingsByQuery()` is the basic search method and returns a list of `Settings.` A more advanced search may be performed with `getSettingsBySearch().` It accepts an `SettingSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSettingsBySearch()` returns an `SettingSearchResults` that can be used to access the resulting `SettingList` or be used to perform a search within the result set through `SettingSearch.` This session defines views that offer differing behaviors for searching. federated system view: searches include settings in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to settings in this system Settings may have a query record indicated by their respective record types. The query record is accessed via the `SettingQuery.`
Method	getSettingSearch
Description	Gets a setting search.
Return	`osid.control.SettingSearch`		the setting search
Compliance	`mandatory`		This method must be implemented.
Method	getSettingSearchOrder
Description	Gets a setting search order. The `SettingSearchOrder` is supplied to a `SettingSearch` to specify the ordering of results.
Return	`osid.control.SettingSearchOrder`		the setting search order
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.SettingQuery`	`settingQuery`	the setting query
Parameters	`osid.control.SettingSearch`	`settingSearch`	the setting search
Return	`osid.control.SettingSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`settingQuery` or `settingSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`settingQuery` or `settingSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSettingQueryFromInspector
Description	Gets a setting query from an inspector. The inspector is available from a `SettingSearchResults.`
Parameters	`osid.control.SettingQueryInspector`	`settingQueryInspector`	a setting query inspector
Return	`osid.control.SettingQuery`		the setting query
Errors	NULL_ARGUMENT		`settingQueryInspector` is `null`
Errors	UNSUPPORTED		`settingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.