OSID - osid.authorization.AuthorizationVaultAssignmentSession Service Interface Definition

Interface	osid.authorization.AuthorizationVaultAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session provides methods to re-assign `Authorizations` to `Vault`. An `Authorization` may map to multiple `Vault` objects and removing the last reference to a `Authorization` is the equivalent of deleting it. Each `Vault` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of a `Authorization` to another `Vault` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignAuthorizations
Description	Tests if this user can alter authorization/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignAuthorizationsToVault
Description	Tests if this user can alter authorization/vault mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`vaultId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableVaultIds
Description	Gets a list of vault including and under the given vault node in which any authorization can be assigned.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Return	`osid.id.IdList`		list of assignable vault `Ids`
Errors	NULL_ARGUMENT		`vaultId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableVaultIdsForAuthorization
Description	Gets a list of vault including and under the given vault node in which a specific authorization can be assigned.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Parameters	`osid.id.Id`	`authorizationId`	the `Id` of the `Authorization`
Return	`osid.id.IdList`		list of assignable vault `Ids`
Errors	NULL_ARGUMENT		`vaultId` or `authorizationId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignAuthorizationToVault
Description	Adds an existing `Authorization` to a `Vault`.
Parameters	`osid.id.Id`	`authorizationId`	the `Id` of the `Authorization`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Errors	ALREADY_EXISTS		`authorizationId` is already assigned to `vaultId`
	NOT_FOUND		`authorizationId` or `vaultId` not found
	NULL_ARGUMENT		`authorizationId` or `vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAuthorizationFromVault
Description	Removes an `Authorization` from a `Vault`.
Parameters	`osid.id.Id`	`authorizationId`	the `Id` of the `Authorization`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Errors	NOT_FOUND		`authorizationId` or `vaultId` not found or `authorizationId` not assigned to `vaultId`
	NULL_ARGUMENT		`authorizationId` or `vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAuthorizationToVault
Description	Moves an `Authorization` from one `Vault` to another. Mappings to other `Vaults` are unaffected.
Parameters	`osid.id.Id`	`authorizationId`	the `Id` of the `Authorization`
	`osid.id.Id`	`fromVaultId`	the `Id` of the current `Vault`
	`osid.id.Id`	`toVaultId`	the `Id` of the destination `Vault`
Errors	ALREADY_EXISTS		`authorizationId` already assigned to `toVaultId`
	NOT_FOUND		`authorizationId, fromVaultId`, or `toVaultId` not found or `authorizationId` not mapped to `fromVaultId`
	NULL_ARGUMENT		`authorizationId, fromVaultId`, or `toVaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.