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

Interface	osid.provisioning.rules.PoolProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `PoolProcessorEnablers` to `PoolProcessors`. Multiple `PoolProcessorEnablers` applied to an `PoolProcessor` may be sequenced such that the first positive evaluation results in the `PoolProcessorEnabler` 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	canAssignPoolProcessorEnablers
Description	Tests if this user can alter pool processor enabler/pool processor 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	assignPoolProcessorEnablerToPoolProcessor
Description	Adds an existing `PoolProcessorEnabler` to a `PoolProcessor`.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler`
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
Errors	ALREADY_EXISTS		`poolProcessorEnablerId` already applied to `poolProcessorId`
	NOT_FOUND		`poolProcessorEnablerId` or `poolProcessorId` not found
	NULL_ARGUMENT		`poolProcessorEnablerId` or `poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPoolProcessorEnablerFromPoolProcessor
Description	Removes an existing `PoolProcessorEnabler` from a `PoolProcessor`.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler`
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
Errors	NOT_FOUND		`poolProcessorEnablerId` or `poolProcessorId` not found or `poolProcessorEnablerId` already applied to `poolProcessorId`
	NULL_ARGUMENT		`poolProcessorEnablerId` or `poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequencePoolProcessorEnablers
Description	Tests if this user can order `PoolProcessorEnablers`. 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 `PoolProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	movePoolProcessorEnablerAhead
Description	Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler in front of a reference pool processor enabler.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler`
	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
	`osid.id.Id`	`referenceId`	the reference pool processor enabler `Id`
Errors	NOT_FOUND		`poolProcessorEnablerId poolProcessorId`, or `referenceId` not found or, `poolProcessorEnablerId` or `referenceId` not related to `poolProcessorId`
	NULL_ARGUMENT		`poolProcessorEnablerId, poolProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	movePoolProcessorEnablerBehind
Description	Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler behind a reference pool processor enabler.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler`
	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
	`osid.id.Id`	`referenceId`	the reference pool processor `Id`
Errors	NOT_FOUND		`poolProcessorEnablerId poolProcessorId`, or `referenceId` not found or, `poolProcessorEnablerId` or `referenceId` not related to `poolProcessorId`
	NULL_ARGUMENT		`poolProcessorEnablerId, poolProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderPoolProcessorEnablers
Description	Reorders a set of pool processor enablers for a pool processor.
Parameters	`osid.id.Id[]`	`poolProcessorEnablerIds`	the `Ids` for a set of `PoolProcessorEnablers`
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
Errors	NOT_FOUND		`poolProcessorId` not found or, a `poolProcessorEnablerId` not related to `poolProcessorId`
	NULL_ARGUMENT		`poolProcessorEnablerIds` or `poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.