OSID - osid.configuration.ConfigurationAdminSession Service Interface Definition

Interface	osid.configuration.ConfigurationAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Configuration.` 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 `Configuration,` a `ConfigurationForm` is requested using `getConfigurationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ConfigurationForm` 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 `ConfigurationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ConfigurationForm` corresponds to an attempted transaction. For updates, `ConfigurationForms` are requested to the `Configuration` `Id` that is to be updated using `getConfigurationFormForUpdate().` Similarly, the `ConfigurationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ConfigurationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Configurations.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateConfigurations
Description	Tests if this user can create `Configurations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a C `onfiguration` 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 `Configuration` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateConfigurationWithRecordTypes
Description	Tests if this user can create a single `Configuration` using the desired record types. While `ConfigurationManager.getConfigurationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Configuration.` Providing an empty array tests if a `Configuration` can be created with no records.
Parameters	`osid.type.Type[]`	`configurationRecordTypes`	array of configuration record types
Return	`boolean`		`true` if `Configuration` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`configurationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationFormForCreate
Description	Gets the configuration form for creating new configurations. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`configurationRecordTypes`	array of configuration record types
Return	`osid.configuration.ConfigurationForm`		the configuration form
Errors	NULL_ARGUMENT		`configurationRecordTypes` 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	createConfiguration
Description	Creates a new `Configuration.`
Parameters	`osid.configuration.ConfigurationForm`	`configurationForm`	the configuration form
Return	`osid.configuration.Configuration`		the new `Configuration`
Errors	ILLEGAL_STATE		`configurationForm` already used in a create transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`configurationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`configurationForm` did not originate from `getConfigurationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateConfigurations
Description	Tests if this user can update `Configurations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a C `onfiguration` 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 `Configuration` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationFormForUpdate
Description	Gets the configuration form for updating existing configurations. A new configuration form should be requested for each update transaction.
Parameters	`osid.id.Id`	`configurationId`	`Id` of a `Configuration`
Return	`osid.configuration.ConfigurationForm`		the configuration form
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	updateConfiguration
Description	Updates an existing `Configuration.`
Parameters	`osid.configuration.ConfigurationForm`	`configurationForm`	the configuration form
Errors	ILLEGAL_STATE		`configurationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`configurationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`configurationForm` did not originate from `getConfigurationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteConfigurations
Description	Tests if this user can delete `Configurations.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Configuration` 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 `Configuration` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteConfiguration
Description	Deletes a `Configuration.`
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to delete
Errors	NOT_FOUND		`configurationId` 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	canManageConfigurationAliases
Description	Tests if this user can manage `Id` aliases for `Configurations.` 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 `Configuration` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasConfiguration
Description	Adds an `Id` to a `Configuration` for the purpose of creating compatibility. The primary `Id` of the `Configuration` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another configuration it is reassigned to the given configuration `Id.`
Parameters	`osid.id.Id`	`configurationId`	the `Id` of a `Configuration`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`configurationId` not found
	NULL_ARGUMENT		`configurationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.