OSID - osid.provisioning.ProvisionableDistributorAssignmentSession Service Interface Definition

Interface	osid.provisioning.ProvisionableDistributorAssignmentSession
Implements	`osid.OsidSession`
Description	This session provides methods to re-assign `Provisionables` to `Distributor` mappings. A `Provisionable` may appear in multiple `Distributor` objects and removing the last reference to a `Provisionable` 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 `Provisionable` to another `Distributor` is not a copy operation (eg: does not change its `Id`).
Method	canAssignProvisionables
Description	Tests if this user can alter provisionable/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 provisionable is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignProvisionablesToDistributor
Description	Tests if this user can alter provisionable/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 mapping 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 provisionable 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	getAssignableDistributorIdsForProvisionable
Description	Gets a list of distributors including and under the given distributor node in which a specific provisionable can be assigned.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Return	`osid.id.IdList`		list of assignable distributor `Ids`
Errors	NULL_ARGUMENT		`distributorId` or `provisionableId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignProvisionableToDistributor
Description	Adds an existing `Provisionable` to a `Distributor`.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	ALREADY_EXISTS		`provisionableId` is already assigned to `distributorId`
	NOT_FOUND		`provisionableId` or `distributorId` not found
	NULL_ARGUMENT		`provisionableId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProvisionableFromDistributor
Description	Removes a `Provisionable` from a `Distributor`.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	NOT_FOUND		`provisionableId` or `distributorId` not found or `provisionableId` not assigned to `distributorId`
	NULL_ARGUMENT		`provisionableId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignProvisionableToDistributor
Description	Moves a `Provisionable` from one `Distributor` to another. Mappings to other `Distributors` are unaffected.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
	`osid.id.Id`	`fromDistributorId`	the `Id` of the current `Distributor`
	`osid.id.Id`	`toDistributorId`	the `Id` of the destination `Distributor`
Errors	ALREADY_EXISTS		`provisionableId` already assigned to `toDistributorId`
	NOT_FOUND		`provisionableId, fromDistributorId`, or `toDistributorId` not found or `provisionableId` not mapped to `fromDistributorId`
	NULL_ARGUMENT		`provisionableId, fromDistributorId`, or `toDistributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.