OSID - osid.resource.ResourceAgentAssignmentSession Service Interface Definition

Interface	osid.resource.ResourceAgentAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session provides methods to re-assign `Resource` to `Agents`. A `Resource` may be associated with multiple `Agents`. An `Agent` may map to only one `Resource`.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignAgents
Description	Tests if this user can alter resource/agent 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	canAssignAgentsToResource
Description	Tests if this user can alter resource/agent mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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`	`resourceId`	the `Id` of the `Resource`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	assignAgentToResource
Description	Adds an existing `Agent` to a `Resource`.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
Errors	ALREADY_EXISTS		`agentId` is already assigned to `resourceId`
	NOT_FOUND		`agentId` or `resourceId` not found
	NULL_ARGUMENT		`agentId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAgentFromResource
Description	Removes an `Agent` from a `Resource`.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
Errors	NOT_FOUND		`agentId` or `resourceId` not found or `agentId` not assigned to `resourceId`
	NULL_ARGUMENT		`agentId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAgentToResource
Description	Moves an `Agent` from one `Resource` to another.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
	`osid.id.Id`	`fromResourceId`	the `Id` of the current `Resource`
	`osid.id.Id`	`toResourceId`	the `Id` of the destination `Resource`
Errors	ALREADY_EXISTS		`agentId` already assigned to `toBinId`
	NOT_FOUND		`agentId, fromResourceId`, or `toResourceId` not found or `agentId` not mapped to `fromResourceId`
	NULL_ARGUMENT		`agentId, fromResourceId`, or `toResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.