OSID - osid.configuration.ParameterQuerySession Service Interface Definition

Interface	osid.configuration.ParameterQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.configuration.ParameterSearchSession`
Used By	`osid.configuration.ConfigurationManager`
Used By	`osid.configuration.ConfigurationProxyManager`
Description	This session provides methods for searching `Parameters`. The search query is constructed using the `ParameterQuery`. Two views of the configuration data are defined; federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included isolated: parameters 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	canSearchParameters
Description	Tests if this user can perform `Parameter` 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 parameters 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	getParameterQuery
Description	Gets a paraameter query.
Return	`osid.configuration.ParameterQuery`		the parameter query
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByQuery
Description	Gets a list of `Parameters` matching the given query.
Parameters	`osid.configuration.ParameterQuery`	`parameterQuery`	the parameter query
Return	`osid.configuration.ParameterList`		the returned `ParameterList`
Errors	NULL_ARGUMENT		`parameterQuery` 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.