OSID - osid.configuration.ParameterLookupSession Service Interface Definition

Interface	osid.configuration.ParameterLookupSession
Implements	`osid.OsidSession`
Description	This session is used to retrieve parameters from a configuration registry of parameters. This lookup session defines several views. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete and ordered result set or is an error condition isolated configuration view: All parameter methods in this session operate, retrieve and pertain to parameters defined explicitly in the current configuration. Using an isolated view is useful for managing `Parameters` with the `ParameterAdminSession.` federated configuration view; All parameter methods in this session operate, retrieve and pertain to all parameters defined in this configuration and any other parameters implicitly available in this configuration through configuration inheritence. active parameter view: All parameter lookup methods return active parameters. any status parameter view: Parameters of any active or inactive status are returned from methods. The methods `federateParameterView()` and `isolateParameterView()` behave as a radio group and one should be selected before invoking any lookup 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	canLookupParameters
Description	Tests if this user can perform `Parameter` 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	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	useFederatedConfigurationView
Description	Federates the view for methods in this session. A federated view will include paramaters 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	useActiveParameterView
Description	Only active parameters are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusParameterView
Description	All active and inactive parameters are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getParameter
Description	Gets the `Parameter` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Parameter` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Parameter` and retained for compatibility. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to retrieve
Return	`osid.configuration.Parameter`		the returned `Parameter`
Errors	NOT_FOUND		no `Parameter` found with the given `Id`
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByIds
Description	Gets a `ParameterList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the parameters 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 `Parameters` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Parameters	`osid.id.IdList`	`parameterIds`	the list of `Ids` to retrieve
Return	`osid.configuration.ParameterList`		the returned `Parameter` list
Errors	NOT_FOUND		an `Id was` 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	getParametersByGenusType
Description	Gets a `ParameterList` corresponding to the given parameter genus `Type` which does not include parameters of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Parameters	`osid.type.Type`	`parameterGenusType`	a parameter genus type
Return	`osid.configuration.ParameterList`		the returned `Parameter list`
Errors	NULL_ARGUMENT		`parameterGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByParentGenusType
Description	Gets a `ParameterList` corresponding to the given parameters genus `Type` and include any additional parameters with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Parameters	`osid.type.Type`	`parameterGenusType`	a parameter genus type
Return	`osid.configuration.ParameterList`		the returned `Parameter list`
Errors	NULL_ARGUMENT		`parameterGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParametersByRecordType
Description	Gets a `ParameterList` corresponding to the given parameter record `Type` which does not include parameters of record types derived from the specified `Type.` In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Parameters	`osid.type.Type`	`parameterRecordType`	a parameter type
Return	`osid.configuration.ParameterList`		the returned `Parameter` list
Errors	NULL_ARGUMENT		`parameterRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameters
Description	Gets all `Parameters.` In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session. In active mode, parameters are returned that are currently active. In any status mode, active and inactive parameters are returned.
Return	`osid.configuration.ParameterList`		a list of `Parameters`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.