OSID - osid.configuration.ValueQuerySession Service Interface Definition

Interface	osid.configuration.ValueQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.configuration.ValueSearchSession`
Used By	`osid.configuration.ConfigurationManager`
Used By	`osid.configuration.ConfigurationProxyManager`
Description	This session provides methods for searching `Values`. The search query is constructed using the `ValueQuery`. The parameter `Type` also specifies the record for the value query. 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	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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchValues
Description	Tests if this user can perform `Value` searches. 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 opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if lookup 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 values from parent configurations 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 searches to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	getValueQuery
Description	Gets a value query.
Return	`osid.configuration.ValueQuery`		the value query
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByQuery
Description	Gets a list of `Values` matching the given value query.
Parameters	`osid.configuration.ValueQuery`	`valueQuery`	the value query
Return	`osid.configuration.ValueList`		the returned `ValueList`
Errors	NULL_ARGUMENT		`valueQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		a query form is not of this service
Compliance	`mandatory`		This method must be implemented.