OSID - osid.authorization.rules.AuthorizationEnablerVaultAssignmentSession Service Interface Definition

Interface	osid.authorization.rules.AuthorizationEnablerVaultAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.rules.AuthorizationRulesManager`
Used By	`osid.authorization.rules.AuthorizationRulesProxyManager`
Description	This session provides methods to re-assign `AuthorizationEnabler` to `Vault` mappings. An `AuthorizationEnabler` may appear in multiple `Vaults` and removing the last reference to an `AuthorizationEnabler` is the equivalent of deleting it. Each `Vault` may have its own authorizations governing who is allowed to operate on it. Adding a reference of an `AuthorizationEnabler` to another `Vault` is not a copy operation (eg: does not change its `Id`).
Method	canAssignAuthorizationEnablers
Description	Tests if this user can alter authorization enabler/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignAuthorizationEnablersToVault
Description	Tests if this user can alter authorization enabler/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 lookup 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 vaults including and under the given vault node in which any authorization enabler 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	getAssignableVaultIdsForAuthorizationEnabler
Description	Gets a list of vaults including and under the given vault node in which a specific authorization enabler can be assigned.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler`
Return	`osid.id.IdList`		list of assignable vault `Ids`
Errors	NULL_ARGUMENT		`vaultId` or `authorizationEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignAuthorizationEnablerToVault
Description	Adds an existing `AuthorizationEnabler` to a `Vault`.
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Errors	ALREADY_EXISTS		`authorizationEnablerId` already assigned to `vaultI`
	NOT_FOUND		`authorizationEnablerId` or `vaultId` not found
	NULL_ARGUMENT		`authorizationEnablerId` or `vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAuthorizationEnablerFromVault
Description	Removes an `AuthorizationEnabler` from a `Vault`.
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault`
Errors	NOT_FOUND		`authorizationEnablerId` or `vaultId` not found or `authorizationEnablerId` not assigned to `vaultId`
	NULL_ARGUMENT		`authorizationEnablerId` or `vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAuthorizationEnablerToVault
Description	Moves an `AuthorizationEnabler` from one `Vault` to another. Mappings to other `Vaults` are unaffected.
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler`
	`osid.id.Id`	`fromVaultId`	the `Id` of the current `Vault`
	`osid.id.Id`	`toVaultId`	the `Id` of the destination `Vault`
Errors	ALREADY_EXISTS		`authorizationEnablerId` already assigned to `toUVaultId`
	NOT_FOUND		`authorizationEnablerId, fromVaultId`, or `toVaultId` not found or `authorizationEnablerId` not mapped to `fromVaultId`
	NULL_ARGUMENT		`authorizationEnablerId, fromVaultId`, or `toVaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.