OSID - osid.configuration.ParameterConfigurationSession Service Interface Definition

Interface	osid.configuration.ParameterConfigurationSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.ConfigurationManager`
Used By	`osid.configuration.ConfigurationProxyManager`
Description	This session defines methods for accessing the configurations of a parameter. A `Parameter` may appear in multiple `Configurations`. Each `Configuration` may have its own authorizations governing who is allowed to look at it. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupParameterConfigurations
Description	Tests if this user can perform lookups on configurations of parameters. 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.
Return	`boolean`		`false` if lookups are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeParameterView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryParameterView
Description	A complete view of the `Parameter` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getParameterIdsByConfiguration
Description	Gets the list of `Parameter` `Ids` associated with a `Configuration`.
Parameters	`osid.id.Id`	`configurationId`	`Id` of the `Configuration`
Return	`osid.id.IdList`		list of matching parameter `Ids`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByConfiguration
Description	Gets the list of `Parameters` associated with a `Configuration`.
Parameters	`osid.id.Id`	`configurationId`	`Id` of the `Configuration`
Return	`osid.configuration.ParameterList`		list of matching parameters
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterIdsByConfigurations
Description	Gets the list of `Parameter Ids` associated with a list of `Configurations`.
Parameters	`osid.id.IdList`	`configurationIds`	list of configurations
Return	`osid.id.IdList`		list of parameter `Ids`
Errors	NULL_ARGUMENT		`configurationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByConfigurations
Description	Gets the list of `Parameters` associated with a list of `Configurations`.
Parameters	`osid.id.IdList`	`configurationIds`	list of configurations
Return	`osid.configuration.ParameterList`		list of parameters
Errors	NULL_ARGUMENT		`configurationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationIdsByParameter
Description	Gets the `Configuration Ids` mapped to a `Parameter`.
Parameters	`osid.id.Id`	`parameterId`	`Id` of a `Parameter`
Return	`osid.id.IdList`		list of configuration `Ids`
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationsByParameter
Description	Gets the `Configurations` mapped to a `Parameter`.
Parameters	`osid.id.Id`	`parameterId`	`Id` of a `Parameter`
Return	`osid.configuration.ConfigurationList`		list of configurations
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.