OSID - osid.provisioning.PoolDistributorAssignmentSession Service Interface Definition

Interface	osid.provisioning.PoolDistributorAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods to re-assign `Pools` to `Distributor` mappings. A `Pool` may appear in multiple `Distributor` objects and removing the last reference to a `Pool` is the equivalent of deleting it. Each `Distributor` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Pool` to another `Distributor` is not a copy operation (eg: does not change its `Id`).
Method	canAssignPools
Description	Tests if this user can alter pool/distributor 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 pool assignment is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignPoolsToDistributor
Description	Tests if this user can alter pool/distributor 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`	`distributorId`	the `Id` of the `Distributor`
Return	`boolean`		`false` if pool assignment is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDistributorIds
Description	Gets a list of distributors including and under the given distributor node in which any pool can be assigned.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Return	`osid.id.IdList`		list of assignable distributor `Ids`
Errors	NULL_ARGUMENT		`distributorId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDistributorIdsForPool
Description	Gets a list of distributors including and under the given distributor node in which a specific pool can be assigned.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Return	`osid.id.IdList`		list of assignable distributor `Ids`
Errors	NULL_ARGUMENT		`distributorId` or `poolId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignPoolToDistributor
Description	Adds an existing `Pool` to a `Distributor`.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	ALREADY_EXISTS		`poolId` is already assigned to `distributorId`
	NOT_FOUND		`poolId` or `distributorId` not found
	NULL_ARGUMENT		`poolId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPoolFromDistributor
Description	Removes a `Pool` from a `Distributor`.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	NOT_FOUND		`poolId` or `distributorId` not found or `poolId` not assigned to `distributorId`
	NULL_ARGUMENT		`poolId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignPoolToDistributor
Description	Moves a `Pool` from one `Distributor` to another. Mappings to other `Distributors` are unaffected.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
	`osid.id.Id`	`fromDistributorId`	the `Id` of the current `Distributor`
	`osid.id.Id`	`toDistributorId`	the `Id` of the destination `Distributor`
Errors	ALREADY_EXISTS		`poolId` already assigned to `toDistributorId`
	NOT_FOUND		`poolId, fromDistributorId`, or `toDistributorId` not found or `poolId` not mapped to `fromDistributorId`
	NULL_ARGUMENT		`poolId, fromDistributorId`, or `toDistributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.