OSID - osid.authentication.keys.KeyAgencyAssignmentSession Service Interface Definition

Interface	osid.authentication.keys.KeyAgencyAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.authentication.keys.AuthenticationKeysManager`
Used By	`osid.authentication.keys.AuthenticationKeysProxyManager`
Description	This session provides methods to re-assign `Keys` to `Agencies` An `Key` may map to multiple `Agency` objects and removing the last reference to an `Key` is the equivalent of deleting it. Each `Agency` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of an `Ageny` to another `Agency` is not a copy operation (eg: does not change its `Id`).
Method	canAssignKeys
Description	Tests if this user can alter key/agency 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	canAssignKeysToAgency
Description	Tests if this user can alter key/agency 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`	`agencyId`	the `Id` of the `Agency`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`agencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableAgencyIds
Description	Gets a list of agencies including and under the given agency node in which any key can be assigned.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency`
Return	`osid.id.IdList`		list of assignable agency `Ids`
Errors	NULL_ARGUMENT		`agencyId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableAgencyIdsForKey
Description	Gets a list of agencies including and under the given agency node in which a specific key can be assigned.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency`
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key`
Return	`osid.id.IdList`		list of assignable bin `Ids`
Errors	NULL_ARGUMENT		`agencyId` or `keyId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignKeyToAgency
Description	Adds an existing `Key` to an `Agency`.
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key`
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency`
Errors	ALREADY_EXISTS		`keyId` is already assigned to `agencyId`
	NOT_FOUND		`keyId` or `agencyId` not found
	NULL_ARGUMENT		`keyId` or `agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignKeyFromAgency
Description	Removes an `Key` from an `Agency`.
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key`
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency`
Errors	NOT_FOUND		`keyId` or `agencyId` not found or `keyId` not assigned to `agencyId`
	NULL_ARGUMENT		`keyId` or `agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignKeyToAgency
Description	Moves a `Key` from one `Agency` to another. Mappings to other `Agencies` are unaffected.
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key`
	`osid.id.Id`	`fromAgencyId`	the `Id` of the current `Agency`
	`osid.id.Id`	`toAgencyId`	the `Id` of the destination `Agency`
Errors	ALREADY_EXISTS		`keyId` already assigned to `toAgencyId`
	NOT_FOUND		`keyId, fromAgencyId`, or `toAgencyId` not found or `keyId` not mapped to `fromAgencyId`
	NULL_ARGUMENT		`keyId, fromAgencyId`, or `toAgencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.