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

Interface	osid.provisioning.rules.BrokerConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `BrokerConstrainerEnablers` to `BrokerConstrainers` . Multiple `BrokerConstrainerEnablers` applied to an `BrokerConstrainer` may be sequenced such that the first positive evaluation results in the `BrokerConstrainerEnabler` 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	canAssignBrokerConstrainerEnablers
Description	Tests if this user can alter broker constrainer enabler/broker constrainer 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	assignBrokerConstrainerEnablerToBrokerConstrainer
Description	Adds an existing `BrokerConstrainerEnabler` to a `BrokerConstrainer` .
Parameters	`osid.id.Id`	`brokerConstrainerEnablerId`	the `Id` of the `BrokerConstrainerEnabler`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Errors	ALREADY_EXISTS		`brokerConstrainerEnablerId` already applied to `brokerConstrainerId`
	NOT_FOUND		`brokerConstrainerEnablerId` or `brokerConstrainerId` not found
	NULL_ARGUMENT		`brokerConstrainerEnablerId` or `brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBrokerConstrainerEnablerFromBrokerConstrainer
Description	Removes an existing `BrokerConstrainerEnabler` from a `BrokerConstrainer` .
Parameters	`osid.id.Id`	`brokerConstrainerEnablerId`	the `Id` of the `BrokerConstrainerEnabler`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Errors	NOT_FOUND		`brokerConstrainerEnablerId` or `brokerConstrainerId` not found or `brokerConstrainerEnablerId` already applied to `brokerConstrainerId`
	NULL_ARGUMENT		`brokerConstrainerEnablerId` or `brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceBrokerConstrainerEnablers
Description	Tests if this user can order `BrokerConstrainerEnablers` . 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 `BrokerConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerConstrainerEnablerAhead
Description	Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler in front of a reference broker constrainer enabler.
Parameters	`osid.id.Id`	`brokerConstrainerEnablerId`	the `Id` of the `BrokerConstrainerEnabler`
	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
	`osid.id.Id`	`referenceId`	the reference broker constrainer enabler `Id`
Errors	NOT_FOUND		`brokerConstrainerEnablerId brokerConstrainerId` , or `referenceId` not found or, `brokerConstrainerEnablerId` or `referenceId` not related to `brokerConstrainerId`
	NULL_ARGUMENT		`brokerConstrainerEnablerId, brokerConstrainerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerConstrainerEnablerBehind
Description	Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler behind a reference broker constrainer enabler.
Parameters	`osid.id.Id`	`brokerConstrainerEnablerId`	the `Id` of the `BrokerConstrainerEnabler`
	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
	`osid.id.Id`	`referenceId`	the reference broker constrainer `Id`
Errors	NOT_FOUND		`brokerConstrainerEnablerId brokerConstrainerId` , or `referenceId` not found or, `brokerConstrainerEnablerId` or `referenceId` not related to `brokerConstrainerId`
	NULL_ARGUMENT		`brokerConstrainerEnablerId, brokerConstrainerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderBrokerConstrainerEnablers
Description	Reorders a set of broker constrainer enablers for a broker constrainer.
Parameters	`osid.id.Id[]`	`brokerConstrainerEnablerIds`	the `Ids` for a set of `BrokerConstrainerEnablers`
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Errors	NOT_FOUND		`brokerConstrainerId` not found or, a `brokerConstrainerEnablerId` not related to `brokerConstrainerId`
	NULL_ARGUMENT		`brokerConstrainerEnablerIds` or `brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.