OSID - osid.control.SettingLookupSession Service Interface Definition

Interface	osid.control.SettingLookupSession
Implements	`osid.OsidSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session defines methods for retrieving settings. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated system view: All setting methods in this session operate, retrieve and pertain to settings defined explicitly in the current system. Using an isolated view is useful for managing `Settings` with the `SettingAdminSession`. federated system view: All setting lookup methods in this session operate, retrieve and pertain to all settings defined in this system and any other settings implicitly available in this system through system inheritence. The methods `useFederatedSystemView()` and `useIsolatedSystemView()` behave as a radio group and one should be selected before invoking any lookup methods. Settings may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the settings.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupSettings
Description	Tests if this user can perform `Setting` 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 not 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	useComparativeSettingView
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	usePlenarySettingView
Description	A complete view of the `Setting` 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include settings in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	getSetting
Description	Gets the `Setting` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Setting` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Setting` and retained for compatibility.
Parameters	`osid.id.Id`	`settingId`	the `Id` of the `Setting` to retrieve
Return	`osid.control.Setting`		the returned `Setting`
Errors	NOT_FOUND		no `Setting` found with the given `Id`
	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsByIds
Description	Gets a `SettingList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the settings 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 `Settings` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`settingIds`	the list of `Ids` to retrieve
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`settingIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsByGenusType
Description	Gets a `SettingList` corresponding to the given setting genus `Type` which does not include settings of types derived from the specified `Type`. In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
Parameters	`osid.type.Type`	`settingGenusType`	a setting genus type
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	NULL_ARGUMENT		`settingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsByParentGenusType
Description	Gets a `SettingList` corresponding to the given setting genus `Type` and include any additional settings with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
Parameters	`osid.type.Type`	`settingGenusType`	a setting genus type
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	NULL_ARGUMENT		`settingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsByRecordType
Description	Gets a `SettingList` containing the given setting record `Type`. In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
Parameters	`osid.type.Type`	`settingRecordType`	a setting record type
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	NULL_ARGUMENT		`settingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsForController
Description	Gets a list of settings for a controller. In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session.
Parameters	`osid.id.Id`	`controllerId`	a controller `Id`
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSettings
Description	Gets all settings. In plenary mode, the returned list contains all of the settings including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Settings may be omitted from the list and may present the elements in any order including returning a unique set.
Return	`osid.control.SettingList`		the returned `Setting` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.