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

Interface	osid.provisioning.rules.BrokerConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `BrokerConstrainers` to `Brokers`. Multiple `BrokerConstrainers` applied to an `Broker` may be sequenced such that the first positive evaluation results in the `BrokerConstrainer` used.
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignBrokerConstrainers
Description	Tests if this user can alter broker constrainer/broker 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	assignBrokerConstrainerToBroker
Description	Adds an existing `BrokerConstrainer` to a `Broker`.
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	ALREADY_EXISTS		`brokerConstrainerId` already applied to `brokerId`
	NOT_FOUND		`brokerConstrainerId` or `brokerId` not found
	NULL_ARGUMENT		`brokerConstrainerId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBrokerConstrainerFromBroker
Description	Removes an existing `BrokerConstrainer` from a `Broker`.
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	NOT_FOUND		`brokerConstrainerId` or `brokerId` not found or `brokerConstrainerId` already applied to `brokerId`
	NULL_ARGUMENT		`brokerConstrainerId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceBrokerConstrainers
Description	Tests if this user can order `BrokerConstrainers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `BrokerConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerConstrainerAhead
Description	Reorders broker constrainers for a broker by moving the specified broker constrainer in front of a reference broker constrainer.
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
	`osid.id.Id`	`referenceId`	the reference broker constrainer `Id`
Errors	NOT_FOUND		`brokerConstrainerId, brokerId`, or `referenceId` not found or, `brokerConstrainerId` or `referenceId` not related to `brokerId`
	NULL_ARGUMENT		`brokerConstrainerId, brokerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerConstrainerBehind
Description	Reorders broker constrainers for a broker by moving the specified broker constrainer behind a reference broker constrainer.
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
	`osid.id.Id`	`referenceId`	the reference broker constrainer `Id`
Errors	NOT_FOUND		`brokerConstrainerId, brokerId`, or `referenceId` not found or, `brokerConstrainerId` or `referenceId` not related to `brokerId`
	NULL_ARGUMENT		`brokerConstrainerId, brokerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderBrokerConstrainers
Description	Reorders a set of broker constrainers for a broker.
Parameters	`osid.id.Id[]`	`brokerConstrainerIds`	the `Ids` for a set of `BrokerConstrainers`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	NOT_FOUND		`brokerId` not found or, a `brokerConstrainerId` not related to `brokerId`
	NULL_ARGUMENT		`brokerConstrainerIds` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.