OSID - osid.authorization.FunctionAdminSession Service Interface Definition

Interface	osid.authorization.FunctionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Functions.` 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 `Function,` a `FunctionForm` is requested using `getFunctionFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `FunctionForm` 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 `FunctionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `FunctionForm` corresponds to an attempted transaction. For updates, `FunctionForms` are requested to the `Function` `Id` that is to be updated using `getFunctionFormForUpdate().` Similarly, the `FunctionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `FunctionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Functions.` To unmap a `Function` from the current `Vault,` the `FunctionVaultAssignmentSession` should be used. These delete operations attempt to remove the `Function` itself thus removing it from all known `Vault` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the vault
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFunctions
Description	Tests if this user can create `Functions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Function` 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 `Function` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFunctionWithRecordTypes
Description	Tests if this user can create a single `Function` using the desired record types. While `AuthorizationManager.getFunctionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Function.` Providing an empty array tests if a `Function` can be created with no records.
Parameters	`osid.type.Type[]`	`functionRecordTypes`	array of function record types
Return	`boolean`		`true` if `Function` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`functionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionFormForCreate
Description	Gets the function form for creating new functions. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`functionRecordTypes`	array of function record types
Return	`osid.authorization.FunctionForm`		the function form
Errors	NULL_ARGUMENT		`functionRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form qith requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createFunction
Description	Creates a new `Function.`
Parameters	`osid.authorization.FunctionForm`	`functionForm`	the form for this `Function`
Return	`osid.authorization.Function`		the new `Function`
Errors	ILLEGAL_STATE		`functionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`functionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`functionForm` did not originate from `getFunctionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateFunctions
Description	Tests if this user can update `Functions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Function` 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 function modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionFormForUpdate
Description	Gets the function form for updating an existing function. A new function form should be requested for each update transaction.
Parameters	`osid.id.Id`	`functionId`	the `Id` of the `Function`
Return	`osid.authorization.FunctionForm`		the function form
Errors	NOT_FOUND		`functionId` is not found
	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateFunction
Description	Updates an existing function.
Parameters	`osid.authorization.FunctionForm`	`functionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`functionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`functionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`functionForm` did not originate from `getFunctionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteFunctions
Description	Tests if this user can delete `Functions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Function` 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 `Function` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFunction
Description	Deletes the `Function` identified by the given `Id.`
Parameters	`osid.id.Id`	`functionId`	the `Id` of the `Function` to delete
Errors	NOT_FOUND		a `Function` was not found identified by the given `Id`
	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageFunctionAliases
Description	Tests if this user can manage `Id` aliases for `Functions.` 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 `Function` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFunction
Description	Adds an `Id` to a `Function` for the purpose of creating compatibility. The primary `Id` of the `Function` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another function, it is reassigned to the given function `Id.`
Parameters	`osid.id.Id`	`functionId`	the `Id` of a `Function`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`functionId` not found
	NULL_ARGUMENT		`functionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.