OSID - osid.provisioning.BrokerDistributorAssignmentSession Service Interface Definition

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