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

Interface	osid.provisioning.rules.BrokerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `BrokerEnablers` to `Brokers` . Multiple `BrokerEnablers` applied to an `Broker` may be sequenced such that the first positive evaluation results in the `BrokerEnablers` 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	canAssignBrokerEnablers
Description	Tests if this user can alter broker enabler/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	assignBrokerEnablerToBroker
Description	Adds an existing `BrokerEnabler` to a `Broker` .
Parameters	`osid.id.Id`	`brokerEnablerId`	the `Id` of the `BrokerEnabler`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	ALREADY_EXISTS		`brokerEnablerId` already applied to `brokerId`
	NOT_FOUND		`brokerEnablerId` or `brokerId` not found
	NULL_ARGUMENT		`brokerEnablerId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBrokerEnablerFromBroker
Description	Removes an existing `BrokerEnabler` from a `Broker` .
Parameters	`osid.id.Id`	`brokerEnablerId`	the `Id` of the `BrokerEnabler`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	NOT_FOUND		`brokerEnablerId` or `brokerId` not found or `brokerEnablerId` already applied to `brokerId`
	NULL_ARGUMENT		`brokerEnablerId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceBrokerEnablers
Description	Tests if this user can order `BrokerEnablers` . 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 `BrokerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerEnablerAhead
Description	Reorders broker enablers for a broker by moving the specified broker enabler in front of a reference broker enabler.
Parameters	`osid.id.Id`	`brokerEnablerId`	the `Id` of the `BrokerEnabler`
	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
	`osid.id.Id`	`referenceId`	the reference broker enabler `Id`
Errors	NOT_FOUND		`brokerEnablerId, brokerId` , or `referenceId` not found or, `brokerEnablerId` or `referenceId` not related to `brokerId`
	NULL_ARGUMENT		`brokerEnablerId, brokerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveBrokerEnablerBehind
Description	Reorders broker enablers for a broker by moving the specified broker enabler behind a reference broker enabler.
Parameters	`osid.id.Id`	`brokerEnablerId`	the `Id` of the `BrokerEnabler`
	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
	`osid.id.Id`	`referenceId`	the reference broker enabler `Id`
Errors	NOT_FOUND		`brokerEnablerId, brokerId` , or `referenceId` not found or, `brokerEnablerId` or `referenceId` not related to `brokerId`
	NULL_ARGUMENT		`brokerEnablerId, brokerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderBrokerEnablers
Description	Reorders a set of broker enablers for a broker.
Parameters	`osid.id.Id[]`	`brokerEnablerIds`	the `Ids` for a set of `BrokerEnablers`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Errors	NOT_FOUND		`brokerEnablerId, brokerId` , or `referenceId` not found or, `brokerEnablerId` or `referenceId` not related to `brokerId`
	NULL_ARGUMENT		`brokerEnablerIds, brokerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.