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

Interface	osid.provisioning.rules.BrokerConstrainerDistributorAssignmentSession
Implements	`osid.OsidSession`
Description	This session provides methods to re-assign `BrokerConstrainer` to `Distributor` mappings. A `BrokerConstrainer` may appear in multiple `Distributor` objects and removing the last reference to a `BrokerConstrainer` 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 `BrokerConstrainer` to another `Distributor` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignBrokerConstrainers
Description	Tests if this user can alter broker constrainer/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignBrokerConstrainersToDistributor
Description	Tests if this user can alter broker constrainer/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 lookup 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 constrainer 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	getAssignableDistributorIdsForBrokerConstrainer
Description	Gets a list of distributors including and under the given distributor node in which a specific broker constrainer can be assigned.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Return	`osid.id.IdList`		list of assignable distributor `Ids`
Errors	NULL_ARGUMENT		`distributorId` or `brokerConstrainerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignBrokerConstrainerToDistributor
Description	Adds an existing `BrokerConstrainer` to a `Distributor.`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	ALREADY_EXISTS		`brokerConstrainerId` is already assigned to `distributorId`
	NOT_FOUND		`brokerConstrainerId` or `distributorId` not found
	NULL_ARGUMENT		`brokerConstrainerId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBrokerConstrainerFromDistributor
Description	Removes a `BrokerConstrainer` from a `Distributor.`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor`
Errors	NOT_FOUND		`brokerConstrainerId` or `distributorId` not found or `brokerConstrainerId` not assigned to `distributorId`
	NULL_ARGUMENT		`brokerConstrainerId` or `distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.