OSID - osid.configuration.rules.ValueEnablerAdminSession Service Interface Definition

Interface	osid.configuration.rules.ValueEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session creates and removes value enablers. The data for create and update is provided via the `ValueEnablerForm`.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateValueEnabler
Description	Tests if this user can create value enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ValueEnabler` 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 `ValueEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateValueEnablerWithRecordTypes
Description	Tests if this user can create a single `ValueEnabler` using the desired record types. While `ConfigurationRulesManager.getValueEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ValueEnabler`. Providing an empty array tests if a `ValueEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`valueEnablerRecordTypes`	array of value enabler record types
Return	`boolean`		`true` if `ValueEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`valueEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerFormForCreate
Description	Gets the value enabler form for creating new value enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`valueEnablerRecordTypes`	array of value enabler record types
Return	`osid.configuration.rules.ValueEnablerForm`		the value enabler form
Errors	NULL_ARGUMENT		`valueEnablerRecordTypes` 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	createValueEnabler
Description	Creates a new `ValueEnabler`.
Parameters	`osid.configuration.rules.ValueEnablerForm`	`valueEnablerForm`	the form for this `ValueEnabler`
Return	`osid.configuration.rules.ValueEnabler`		the new `ValueEnabler`
Errors	ILLEGAL_STATE		`valueEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`valueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueEnablerForm` did not originate from `getValueEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateValueEnablers
Description	Tests if this user can update value enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ValueEnabler` 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 `ValueEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerFormForUpdate
Description	Gets the value enabler form for updating an existing value enabler. A new value enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`valueEnablerId`	the `Id` of the `ValueEnabler`
Return	`osid.configuration.rules.ValueEnablerForm`		the value enabler form
Errors	NOT_FOUND		`valueEnablerId` is not found
	NULL_ARGUMENT		`valueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateValueEnabler
Description	Updates an existing value enabler.
Parameters	`osid.configuration.rules.ValueEnablerForm`	`valueEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`valueEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`valueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`valueEnablerForm` did not originate from `getValueEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteValueEnablers
Description	Tests if this user can delete value enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ValueEnabler` 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 `ValueEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteValueEnabler
Description	Deletes a `ValueEnabler`.
Parameters	`osid.id.Id`	`valueEnablerId`	the `Id` of the `ValueEnabler` to remove
Errors	NOT_FOUND		`valueEnablerId` not found
	NULL_ARGUMENT		`valueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageValueEnablerAliases
Description	Tests if this user can manage `Id` aliases for value enablers. 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 `ValueEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasValueEnabler
Description	Adds an `Id` to a `ValueEnabler` for the purpose of creating compatibility. The primary `Id` of the `ValueEnabler` 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 enabler. it is reassigned to the given value enabler `Id`.
Parameters	`osid.id.Id`	`valueEnablerId`	the `Id` of a `ValueEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`valueEnablerId` not found
	NULL_ARGUMENT		`valueEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.