OSID - osid.configuration.ValueRetrievalSession Service Interface Definition

Interface	osid.configuration.ValueRetrievalSession
Implements	`osid.OsidSession`
Implemented By	`osid.configuration.ValueLookupSession`
Used By	`osid.configuration.ConfigurationManager`
Used By	`osid.configuration.ConfigurationProxyManager`
Description	This session is used to retrieve active and applicable configuration values through evaluation of active and pertinent values based on the context or conditional input.
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	canRetrieveValues
Description	Tests if this user can perform `Value` retrievals. 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValueByParameter
Description	Gets an applicable `Value` for the given parameter `Id`. If more than one value exists for the given parameter, the most preferred value is returned. This method can be used as a convenience when only one value is expected. `getValuesByParameters()` should be used for getting all the active values.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to retrieve
Return	`osid.configuration.Value`		the value
Errors	NOT_FOUND		the `parameterId` not found or no value available
	NULL_ARGUMENT		the `parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValuesByParameter
Description	Gets all the applicable `Values` for the given parameter `Id`.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to retrieve
Return	`osid.configuration.ValueList`		the value list
Errors	NOT_FOUND		the `parameterId` not found
	NULL_ARGUMENT		the `parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValuesByParameters
Description	Gets the applicable `Values` for the given parameter `Ids`.
Parameters	`osid.id.IdList`	`parameterIds`	the `Id` of the `Parameter` to retrieve
Return	`osid.configuration.ValueList`		the value list
Errors	NOT_FOUND		a parameter `Id` is not found
	NULL_ARGUMENT		`parameterIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValueCondition
Description	Gets a value condition for the given parameter.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
Return	`osid.configuration.ValueCondition`		a value condition
Errors	NULL_ARGUMENT		`parameterId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValueByParameterOnCondition
Description	Gets an applicable value in this configuration based on a condition. If multiple values are available the most preferred one is returned. The condition specified is applied to any or all parameters in this configuration as applicable.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
Parameters	`osid.configuration.ValueCondition`	`valueCondition`	the condition
Return	`osid.configuration.Value`		the value
Errors	NOT_FOUND		parameter `Id` is not found
	NULL_ARGUMENT		`parameterId` or `valueCondition` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueCondition` did not originate from `getValueCondition()`
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValuesByParameterOnCondition
Description	Gets all the applicable values for a parameter based on a condition.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
Parameters	`osid.configuration.ValueCondition`	`valueCondition`	the condition
Return	`osid.configuration.ValueList`		the value list
Errors	NOT_FOUND		parameter `Id` is not found
	NULL_ARGUMENT		`parameterId` or `valueCondition` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueCondition` did not originate from `getValueCondition()`
Compliance	`mandatory`		This method must be implemented.
Method	getApplicableValuesByParametersOnCondition
Description	Gets the applicable values for parameters based on a condition. The specified condition is applied to any or all of the parameters as applicable.
Parameters	`osid.id.IdList`	`parameterIds`	the `Id` of a `Parameter`
Parameters	`osid.configuration.ValueCondition`	`valueCondition`	the condition
Return	`osid.configuration.ValueList`		the value list
Errors	NOT_FOUND		a parameter `Id` is not found
	NULL_ARGUMENT		`parameterIds` or `valueCondition` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueCondition did not originate from getValueCondition()`
Compliance	`mandatory`		This method must be implemented.