OSID - osid.configuration.ValueAdminSession Service Interface Definition

Interface	osid.configuration.ValueAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Values` 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 `Value,` a `ValueForm` is requested using `getValueFormForCreate()` specifying the desired parameter and record `Types` or none if no record `Types` are needed. The returned `ValueForm` 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 `ValueForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ValueForm` corresponds to an attempted transaction. For updates, `ValueForms` are requested to the `Value` `Id` that is to be updated using `getValueFormForUpdate().` Similarly, the `ValueForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ValueForm` can only be used once for a successful update and cannot be reused. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	supportValueConditions
Description	Tests if applying conditions to values is supported.
Return	`boolean`		`true` if `Value` conditions are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateValues
Description	Tests if this user can create `Values.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Value` 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 `Value` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateValueWithRecordTypes
Description	Tests if this user can create a single `Value` using the desired record types. While `ConfigurationManager.getValueRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Value.` Providing an empty array tests if a `Value` can be created with no records.
Parameters	`osid.type.Type[]`	`valueRecordTypes`	array of value record types
Return	`boolean`		`true` if `Value` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`valueRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueFormForCreate
Description	Gets the form for creating new values. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`parameterId`	the parameter
Parameters	`osid.type.Type[]`	`valueRecordTypes`	array of value record types
Return	`osid.configuration.ValueForm`		the value form
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` or `valueRecordTypes` 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	createValue
Description	Creates a value.
Parameters	`osid.configuration.ValueForm`	`valueForm`	the form
Return	`osid.configuration.Value`		the value
Errors	ILLEGAL_STATE		`valueForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`valueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueForm` did not originate from `getValueFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateValues
Description	Tests if this user can update `Values.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Value` 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 `Value` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getValueFormForUpdate
Description	Gets the value form for updating an existing value. A new value form should be requested for each update transaction.
Parameters	`osid.id.Id`	`valueId`	the `Id` of the `Value`
Return	`osid.configuration.ValueForm`		the value form
Errors	NOT_FOUND		the value is not found
	NULL_ARGUMENT		`parameterId` or `valueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateValue
Description	Updates an existing value.
Parameters	`osid.configuration.ValueForm`	`valueForm`	the form containing the elemnts to be updated
Errors	ILLEGAL_STATE		`valueForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`parameterId, valueId` or `valueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueForm` did not originate from `getValueFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteValues
Description	Tests if this user can delete `Values.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Value` 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 `Value` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteValue
Description	Deletes the specified value.
Parameters	`osid.id.Id`	`valueId`	the `Id` of the `Value` to delete
Errors	NOT_FOUND		`valueId` is not found
	NULL_ARGUMENT		`valueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageValueAliases
Description	Tests if this user can manage `Id` aliases for `Values.` 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 `Value` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasValue
Description	Adds an `Id` to a `Value` for the purpose of creating compatibility. The primary `Id` of the `Value` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another value it is reassigned to the given value `Id.`
Parameters	`osid.id.Id`	`valueId`	the `Id` of a `Value`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`valueId` not found
	NULL_ARGUMENT		`valueId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.