OSID - osid.provisioning.rules.BrokerProcessorDistributorAssignmentSession Service Interface Definition

Interface	osid.provisioning.rules.BrokerProcessorDistributorAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to re-assign `BrokerProcessor` to `Distributor` mappings. A `BrokerProcessor` may appear in multiple `Distributor` catalogs and removing the last reference to a `BrokerProcessor` 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 `BrokerProcessor` to another `Distributor is` not a copy operation (eg: does not change its `Id`).
Method	canAssignBrokerProcessors
Description	Tests if this user can alter broker processor/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. T` his 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	canAssignBrokerProcessorToDistributor
Description	Tests if this user can alter broker processor/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. T` his 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 processor 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	getAssignableDistributorIdsForBrokerProcessor
Description	Gets a list of distributors including and under the given distributor node in which a specific broker processor can be assigned.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Parameters	`osid.id.Id`	`brokerProcessorId`	the `Id` of the `BrokerProcessor`
Return	`osid.id.IdList`		list of assignable distributor `Ids`
Errors	NULL_ARGUMENT		`distributorId` or `brokerProcessorId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignBrokerProcessorToDistributor
Description	Adds an existing `BrokerProcessor` to a `Distributor`.
Parameters	`osid.id.Id`	`brokerProcessorId`	the `Id` of the `BrokerProcessor`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	ALREADY_EXISTS		`brokerProcessorId` is already assigned to `distributorId`
	NOT_FOUND		`brokerProcessorId` or `distributorId` not found
	NULL_ARGUMENT		`brokerProcessorId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBrokerProcessorFromDistributor
Description	Removes a `BrokerProcessor` from a `Distributor`.
Parameters	`osid.id.Id`	`brokerProcessorId`	the `Id` of the `BrokerProcessor`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	NOT_FOUND		`brokerProcessorId` or `distributorId` not found or `brokerProcessorId` not assigned to `distributorId`
	NULL_ARGUMENT		`brokerProcessorId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignBrokerProcessorToDistributor
Description	Moves a `BrokerProcessor` from one `Distributor` to another. Mappings to other `Distributors` are unaffected.
Parameters	`osid.id.Id`	`brokerProcessorId`	the `Id` of the `BrokerProcessor`
	`osid.id.Id`	`fromDistributorId`	the `Id` of the current `Distributor`
	`osid.id.Id`	`toDistributorId`	the `Id` of the destination `Distributor`
Errors	ALREADY_EXISTS		`brokerProcessorId` already assigned to `toDistributorId`
	NOT_FOUND		`brokerProcessorId, fromDistributorId`, or `toDistributorId` not found or `brokerProcessorId` not mapped to `fromDistributorId`
	NULL_ARGUMENT		`brokerProcessorId, fromDistributorId`, or `toDistributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.