OSID - osid.control.SettingAdminSession Service Interface Definition

Interface	osid.control.SettingAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Settings.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Setting,` a `SettingForm` is requested using `getSettingFormForCreate()` specifying the desired controller and record `Types` or none if no record `Types` are needed. The returned `SettingForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `SettingForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SettingForm` corresponds to an attempted transaction. For updates, `SettingForms` are requested to the `Setting` `Id` that is to be updated using `getSettingFormForUpdate().` Similarly, the `SettingForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SettingForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Settings.` To unmap a `Setting` from the current `System,` the `SettingSystemAssignmentSession` should be used. These delete operations attempt to remove the `Setting` itself thus removing it from all known `System` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateSettings
Description	Tests if this user can create settings. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Setting` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Setting` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSettingWithRecordTypes
Description	Tests if this user can create a single `Setting` using the desired record types. While `ControlManager.getSettingRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Setting.` Providing an empty array tests if a `Setting` can be created with no records.
Parameters	`osid.type.Type[]`	`settingRecordTypes`	array of setting record types
Return	`boolean`		`true` if `Setting` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`settingRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSettingFormForCreate
Description	Gets the setting form for creating new settings. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`controllerId`	the `Id` for the controller
Parameters	`osid.type.Type[]`	`settingRecordTypes`	array of setting record types
Return	`osid.control.SettingForm`		the setting form
Errors	NOT_FOUND		`controllerId` is not found
	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createSetting
Description	Creates a new `Setting.`
Parameters	`osid.control.SettingForm`	`settingForm`	the form for this `Setting`
Return	`osid.control.Setting`		the new `Setting`
Errors	ILLEGAL_STATE		`settingForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NOT_FOUND		`resourceId` or `inputId` is not found
	NULL_ARGUMENT		`settingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`settingForm` did not originate from `getSettingFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSettings
Description	Tests if this user can update settings. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Setting` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Setting` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSettingFormForUpdate
Description	Gets the setting form for updating an existing setting. A new setting form should be requested for each update transaction.
Parameters	`osid.id.Id`	`settingId`	the `Id` of the `Setting`
Return	`osid.control.SettingForm`		the setting form
Errors	NOT_FOUND		`settingId` is not found
	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSetting
Description	Updates an existing setting.
Parameters	`osid.control.SettingForm`	`settingForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`settingForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`settingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`settingForm` did not originate from `getSettingFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSettings
Description	Tests if this user can delete settings. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Setting` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Setting` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSetting
Description	Deletes a `Setting.`
Parameters	`osid.id.Id`	`settingId`	the `Id` of the `Setting` to remove
Errors	NOT_FOUND		`settingId` not found
	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSettingAliases
Description	Tests if this user can manage `Id` aliases for `Settings.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Setting` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSetting
Description	Adds an `Id` to a `Setting` for the purpose of creating compatibility. The primary `Id` of the `Setting` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another setting, it is reassigned to the given setting `Id.`
Parameters	`osid.id.Id`	`settingId`	the `Id` of a `Setting`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`settingId` not found
	NULL_ARGUMENT		`settingId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.