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

Interface	osid.configuration.rules.ValueEnablerSearchSession
Implements	`osid.configuration.rules.ValueEnablerQuerySession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session provides methods for searching among `ValueEnabler` objects. The search query is constructed using the `ValueEnableryQuery`. `getValueEnablersByQuery()` is the basic search method and returns a list of `ValueEnablers`. A more advanced search may be performed with `getValueEnablersBySearch()`.It accepts a `ValueEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. `getValueEnablersBySearch()` returns a `ValueEnablerSearchResults` that can be used to access the resulting `ValueEnablerList` or be used to perform a search within the result set through `ValueEnablerSearch`. This session defines views that offer differing behaviors for searching. federated configuration view: searches include value enablers in configurations of which this configuration is an ancestor in the configuration hierarchy isolated configuration view: searches are restricted to value enablers in this configuration `ValueEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ValueEnablerQuery`.
Method	getValueEnablerSearch
Description	Gets a value enabler search.
Return	`osid.configuration.rules.ValueEnablerSearch`		the value enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerSearchOrder
Description	Gets a value enabler search order. The `ValueEnablerSearchOrder` is supplied to a `ValueEnablerSearch` to specify the ordering of results.
Return	`osid.configuration.rules.ValueEnablerSearchOrder`		the value enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.configuration.rules.ValueEnablerQuery`	`valueEnablerQuery`	the value enabler query
Parameters	`osid.configuration.rules.ValueEnablerSearch`	`valueEnablerSearch`	the value enabler search
Return	`osid.configuration.rules.ValueEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`valueEnablerQuery` or `valueEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueEnablerQuery` or `valueEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerQueryFromInspector
Description	Gets a value enabler query from an inspector. The inspector is available from a `ValueEnablerSearchResults`.
Parameters	`osid.configuration.rules.ValueEnablerQueryInspector`	`valueEnablerQueryInspector`	a value enabler query inspector
Return	`osid.configuration.rules.ValueEnablerQuery`		the value enabler query
Errors	NULL_ARGUMENT		`valueEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`valueEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.