OSID - osid.configuration.ValueLookupSession Service Interface Definition

Interface	osid.configuration.ValueLookupSession
Implements	`osid.configuration.ValueRetrievalSession`
Used By	`osid.OsidRuntimeManager`
	`osid.configuration.ConfigurationManager`
	`osid.configuration.ConfigurationProxyManager`
Description	This session is used to retrieve configuration values. Several 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 conditional: values are filtered that do not pass any defined conditions, whether or not they are explciity passed into the lookup methods of this session unconditional: values are filtered only for the conditions that are explicity passed as parameters. Any conditions defined for the value that do not require explicit data for retrieval are ignored. active value view: All value lookup methods return active values. any status value view: Values of any active or inactive status are returned from methods.
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	canLookupValues
Description	Tests if this user can perform `Value` 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 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	useComparativeValueView
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	usePlenaryValueView
Description	A complete view of the `Value` 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	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 lookups to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveValueView
Description	Only active values are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusValueView
Description	All active and inactive values are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getValue
Description	Gets the `Value` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Value` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Value` and retained for compatibility. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Parameters	`osid.id.Id`	`valueId`	the `Id` of the `Value` to retrieve
Return	`osid.configuration.Value`		the returned `Value`
Errors	NOT_FOUND		no `Value` found with the given `Id`
	NULL_ARGUMENT		`valueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByIds
Description	Gets a `ValueList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the values specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Values` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Parameters	`osid.id.IdList`	`valueIds`	the list of `Ids` to retrieve
Return	`osid.configuration.ValueList`		the returned `Value` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`valueIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByGenusType
Description	Gets a `ValueList` corresponding to the given value genus `Type` which does not include values of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known values or an error results. Otherwise, the returned list may contain only those values that are accessible through this session. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Parameters	`osid.type.Type`	`valueGenusType`	a value genus type
Return	`osid.configuration.ValueList`		the returned `Value list`
Errors	NULL_ARGUMENT		`valueGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByParentGenusType
Description	Gets a `ValueList` corresponding to the given value genus `Type` and include any additional values with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known values or an error results. Otherwise, the returned list may contain only those values that are accessible through this session. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Parameters	`osid.type.Type`	`valueGenusType`	a value genus type
Return	`osid.configuration.ValueList`		the returned `Value list`
Errors	NULL_ARGUMENT		`valueGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByRecordType
Description	Gets a `ValueList` corresponding to the given value record `Type` which does not include values of record types derived from the specified `Type`. In plenary mode, the returned list contains all known values or an error results. Otherwise, the returned list may contain only those values that are accessible through this session. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Parameters	`osid.type.Type`	`valueRecordType`	a value type
Return	`osid.configuration.ValueList`		the returned `Value` list
Errors	NULL_ARGUMENT		`valueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValuesByParameter
Description	Gets all the `Values` for the given parameter `Id`. In plenary mode, all values are returned in the order requested or an error results. In comparative mode, inaccessible values may be omitted or the values reordered. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
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	getValues
Description	Gets all the values in this configuration. In plenary mode, all values are returned or an error results. In comparative mode, inaccessible values may be omitted. In plenary mode, the returned list contains all known values or an error results. Otherwise, the returned list may contain only those values that are accessible through this session. In active mode, values are returned that are currently active. In any status mode, active and inactive values are returned.
Return	`osid.configuration.ValueList`		the value list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.