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

Interface	osid.provisioning.rules.BrokerConstrainerDistributorSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `BrokerConstrainer` to `Distributor` mappings. A `BrokerConstrainer` may appear in multiple `Distributor` objects. Each distributor may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupBrokerConstrainerDistributorMappings
Description	Tests if this user can perform lookups of broker constrainer/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBrokerConstrainerDistributorView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBrokerConstrainerDistributorView
Description	A complete view of the `BrokerConstrainer` and `Distributor` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerConstrainerIdsByDistributor
Description	Gets the list of `BrokerConstrainerIds` associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.id.IdList`		list of related broker constrainer `Ids`
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersByDistributor
Description	Gets the list of broker constrainer associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.provisioning.rules.BrokerConstrainerList`		list of related broker constrainers
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerIdsByDistributors
Description	Gets the list of `BrokerConstrainer Ids` corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.id.IdList`		list of broker constrainer `Ids`
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersByDistributors
Description	Gets the list of broker constrainer corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.provisioning.rules.BrokerConstrainerList`		list of broker constrainers
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorIdsByBrokerConstrainer
Description	Gets the `Distributor` `Ids` mapped to a `BrokerConstrainer.`
Parameters	`osid.id.Id`	`brokerConstrainerId`	`Id` of a `BrokerConstrainer`
Return	`osid.id.IdList`		list of distributors
Errors	NOT_FOUND		`brokerConstrainerId` is not found
	NULL_ARGUMENT		`brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorsByBrokerConstrainer
Description	Gets the `Distributors` mapped to a `BrokerConstrainer.`
Parameters	`osid.id.Id`	`brokerConstrainerId`	`Id` of a `BrokerConstrainer`
Return	`osid.provisioning.DistributorList`		list of distributors
Errors	NOT_FOUND		`brokerConstrainerId` is not found
	NULL_ARGUMENT		`brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.