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

Interface	osid.provisioning.rules.ProvisionableEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `ProvisionableEnablers` to `Provisionables`. Multiple `ProvisionableEnablers` applied to an `Provisionable` may be sequenced such that the first positive evaluation results in the `ProvisionableEnablers` 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	canAssignProvisionableEnablers
Description	Tests if this user can alter provisionable enabler/provisionable 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	assignProvisionableEnablerToProvisionable
Description	Adds an existing `ProvisionableEnabler` to a `Provisionable`.
Parameters	`osid.id.Id`	`provisionableEnablerId`	the `Id` of the `ProvisionableEnabler`
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Errors	ALREADY_EXISTS		`provisionableEnablerId` already applied to `provisionableId`
	NOT_FOUND		`provisionableEnablerId` or `provisionableId` not found
	NULL_ARGUMENT		`provisionableEnablerId` or `provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProvisionableEnablerFromProvisionable
Description	Removes an existing `ProvisionableEnabler` from a `Provisionable`.
Parameters	`osid.id.Id`	`provisionableEnablerId`	the `Id` of the `ProvisionableEnabler`
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Errors	NOT_FOUND		`provisionableEnablerId` or `provisionableId` not found or `provisionableEnablerId` already applied to `provisionableId`
	NULL_ARGUMENT		`provisionableEnablerId` or `provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProvisionableEnablers
Description	Tests if this user can order `ProvisionableEnablers`. 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 `ProvisionableEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProvisionableEnablerAhead
Description	Reorders provisionable enablers for a provisionable by moving the specified provisionable enabler in front of a reference provisionable enabler.
Parameters	`osid.id.Id`	`provisionableEnablerId`	the `Id` of the `ProvisionableEnabler`
	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
	`osid.id.Id`	`referenceId`	the reference provisionable enabler `Id`
Errors	NOT_FOUND		`provisionableEnablerId, provisionableId`, or `referenceId` not found or, `provisionableEnablerId` or `referenceId` not related to `provisionableId`
	NULL_ARGUMENT		`provisionableEnablerId, provisionableId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProvisionableEnablerBehind
Description	Reorders provisionable enablers for a provisionable by moving the specified provisionable enabler behind a reference provisionable enabler.
Parameters	`osid.id.Id`	`provisionableEnablerId`	the `Id` of the `ProvisionableEnabler`
	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
	`osid.id.Id`	`referenceId`	the reference provisionable enabler `Id`
Errors	NOT_FOUND		`provisionableEnablerId, provisionableId`, or `referenceId` not found or, `provisionableEnablerId` or `referenceId` not related to `provisionableId`
	NULL_ARGUMENT		`provisionableEnablerId, provisionableId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProvisionableEnablers
Description	Reorders a set of provisionable enablers for a provisionable.
Parameters	`osid.id.Id[]`	`provisionableEnablerIds`	the `Ids` for a set of `ProvisionableEnablers`
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable`
Errors	NOT_FOUND		`provisionableEnablerId, provisionableId`, or `referenceId` not found or, `provisionableEnablerId` or `referenceId` not related to `provisionableId`
	NULL_ARGUMENT		`provisionableEnablerIds, provisionableId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.