OSID - osid.configuration.ParameterAdminSession Service Interface Definition

Interface	osid.configuration.ParameterAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Parameters.` 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 `Parameter,` a `ParameterForm` is requested using `getParameterFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `ParameterForm` 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 `ParameterForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ParameterForm` corresponds to an attempted transaction. For updates, `ParameterForms` are requested to the `Parameter` `Id` that is to be updated using `getParameterFormForUpdate().` Similarly, the `ParameterForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ParameterForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Parameters.` To unmap a `Parameter` from the current `Configuration,` the `ParameterConfigurationAssignmentSession` should be used. These delete operations attempt to remove the `Parameter` itself thus removing it from all known `Configuration` catalogs. 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	canCreateParameters
Description	Tests if this user can create `Parameters.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Parameter` 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 `Parameter` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParameterWithRecordTypes
Description	Tests if this user can create a single `Parameter` using the desired record types. While `ConfigurationManager.getParameterRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Parameter.` Providing an empty array tests if a `Parameter` can be created with no records.
Parameters	`osid.type.Type[]`	`parameterRecordTypes`	array of parameter record types
Return	`boolean`		`true` if `Parameter` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterFormForCreate
Description	Gets the paramater form for creating new parameters.
Parameters	`osid.type.Type[]`	`parameterRecordTypes`	array of parameter record types
Return	`osid.configuration.ParameterForm`		the parameter 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	createParameter
Description	Creates a new `Parameter.`
Parameters	`osid.configuration.ParameterForm`	`parameterForm`	the form for this `Parameter`
Return	`osid.configuration.Parameter`		the new `Parameter`
Errors	ILLEGAL_STATE		`parameterForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`parameterForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterForm` did not originate from `getParameterFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateParameters
Description	Tests if this user can update `Parameters.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Parameter` 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 `Parameter` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterFormForUpdate
Description	Gets the parameter form for updating an existing parameters.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter`
Return	`osid.configuration.ParameterForm`		the parameter form
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateParameter
Description	Updates an existing parameter.
Parameters	`osid.configuration.ParameterForm`	`parameterForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`parameterForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`parameterId` or `parameterForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterForm` did not originate from `getParameterFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteParameters
Description	Tests if this user can delete `Parameters.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Parameter` 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 `Parameter` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteParameter
Description	Deletes a `Parameter.`
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to remove
Errors	NOT_FOUND		`parameterId` not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageParameterAliases
Description	Tests if this user can manage `Id` aliases for `Parameters.` 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 `Parameter` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasParameter
Description	Adds an `Id` to a `Parameter` for the purpose of creating compatibility. The primary `Id` of the `Parameter` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another parameter it is reassigned to the given parameter `Id.`
Parameters	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`parameterId` not found
	NULL_ARGUMENT		`parameterId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.