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

Interface	osid.provisioning.rules.PoolEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `PoolEnablers` to `Pools`. Multiple `PoolEnablers` applied to an `Pool` may be sequenced such that the first positive evaluation results in the `PoolEnablers` 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	canAssignPoolEnablers
Description	Tests if this user can alter pool enabler/pool 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	assignPoolEnablerToPool
Description	Adds an existing `PoolEnabler` to a `Pool`.
Parameters	`osid.id.Id`	`poolEnablerId`	the `Id` of the `PoolEnabler`
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Errors	ALREADY_EXISTS		`poolEnablerId` already applied to `poolId`
	NOT_FOUND		`poolEnablerId` or `poolId` not found
	NULL_ARGUMENT		`poolEnablerId` or `poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPoolEnablerFromPool
Description	Removes an existing `PoolEnabler` from a `Pool`.
Parameters	`osid.id.Id`	`poolEnablerId`	the `Id` of the `PoolEnabler`
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Errors	NOT_FOUND		`poolEnablerId` or `poolId` not found or `poolEnablerId` already applied to `poolId`
	NULL_ARGUMENT		`poolEnablerId` or `poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequencePoolEnablers
Description	Tests if this user can order `PoolEnablers` . 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 `PoolEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	movePoolEnablerAhead
Description	Reorders pool enablers for a pool by moving the specified pool enabler in front of a reference pool enabler.
Parameters	`osid.id.Id`	`poolEnablerId`	the `Id` of the `PoolEnabler`
	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
	`osid.id.Id`	`referenceId`	the reference pool enabler `Id`
Errors	NOT_FOUND		`poolEnablerId, poolId`, or `referenceId` not found or, `poolEnablerId` or `referenceId` not related to `poolId`
	NULL_ARGUMENT		`poolEnablerId, poolId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	movePoolEnablerBehind
Description	Reorders pool enablers for a pool by moving the specified pool enabler behind a reference pool enabler.
Parameters	`osid.id.Id`	`poolEnablerId`	the `Id` of the `PoolEnabler`
	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
	`osid.id.Id`	`referenceId`	the reference pool enabler `Id`
Errors	NOT_FOUND		`poolEnablerId, poolId`, or `referenceId` not found or, `poolEnablerId` or `referenceId` not related to `poolId`
	NULL_ARGUMENT		`poolEnablerId, poolId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderPoolEnablers
Description	Reorders a set of pool enablers for a pool.
Parameters	`osid.id.Id[]`	`poolEnablerIds`	the `Ids` for a set of `PoolEnablers`
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Errors	NOT_FOUND		`poolEnablerId, poolId`, or `referenceId` not found or, `poolEnablerId` or `referenceId` not related to `poolId`
	NULL_ARGUMENT		`poolEnablerIds, poolId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.