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

Interface	osid.configuration.rules.ValueEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.configuration.rules.ValueEnablerSearchSession`
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 `ValueEnablerQuery`. 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 Value enablers may have a query record indicated by their respective record types. The query record is accessed via the `ValueEnablerQuery`.
Method	getConfigurationId
Description	Gets the `Configuration` `Id` associated with this session.
Return	`osid.id.Id`		the `Configuration Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfiguration
Description	Gets the `Configuration` associated with this session.
Return	`osid.configuration.Configuration`		the configuration
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchValueEnablers
Description	Tests if this user can perform `ValueEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedConfigurationView
Description	Federates the view for methods in this session. A federated view will include value enablers in configurations which are children of this broker in the configuration hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedConfigurationView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	getValueEnablerQuery
Description	Gets a value enabler query.
Return	`osid.configuration.rules.ValueEnablerQuery`		the value enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersByQuery
Description	Gets a list of `ValueEnablers` matching the given value enabler query.
Parameters	`osid.configuration.rules.ValueEnablerQuery`	`valueEnablerQuery`	the value enabler query
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnablerList`
Errors	NULL_ARGUMENT		`valueEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.