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

Interface	osid.provisioning.rules.ProvisionEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `ProvisionEnablers` to `Provisions`. Multiple `ProvisionEnablers` applied to an `Provision` may be sequenced such that the first positive evaluation results in the `ProvisionEnablers` 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	canAssignProvisionEnablers
Description	Tests if this user can alter provision enabler/provision 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	assignProvisionEnablerToProvision
Description	Adds an existing `ProvisionEnabler` to a `Provision`.
Parameters	`osid.id.Id`	`provisionEnablerId`	the `Id` of the `ProvisionEnabler`
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
Errors	ALREADY_EXISTS		`provisionEnablerId` already applied to `provisionId`
	NOT_FOUND		`provisionEnablerId` or `provisionId` not found
	NULL_ARGUMENT		`provisionEnablerId` or `provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProvisionEnablerFromProvision
Description	Removes an existing `ProvisionEnabler` from a `Provision`.
Parameters	`osid.id.Id`	`provisionEnablerId`	the `Id` of the `ProvisionEnabler`
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
Errors	NOT_FOUND		`provisionEnablerId` or `provisionId` not found or `provisionEnablerId` already applied to `provisionId`
	NULL_ARGUMENT		`provisionEnablerId` or `provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProvisionEnablers
Description	Tests if this user can order `ProvisionEnablers`. 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 `ProvisionEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProvisionEnablerAhead
Description	Reorders provision enablers for a provision by moving the specified provision enabler in front of a reference provision enabler.
Parameters	`osid.id.Id`	`provisionEnablerId`	the `Id` of the `ProvisionEnabler`
	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
	`osid.id.Id`	`referenceId`	the reference provision enabler `Id`
Errors	NOT_FOUND		`provisionEnablerId, provisionId`, or `referenceId` not found or, `provisionEnablerId` or `referenceId` not related to `provisionId`
	NULL_ARGUMENT		`provisionEnablerId, provisionId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProvisionEnablerBehind
Description	Reorders provision enablers for a provision by moving the specified provision enabler behind a reference provision enabler.
Parameters	`osid.id.Id`	`provisionEnablerId`	the `Id` of the `ProvisionEnabler`
	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
	`osid.id.Id`	`referenceId`	the reference provision enabler `Id`
Errors	NOT_FOUND		`provisionEnablerId, provisionId`, or `referenceId` not found or, `provisionEnablerId` or `referenceId` not related to `provisionId`
	NULL_ARGUMENT		`provisionEnablerId, provisionId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProvisionEnablers
Description	Reorders a set of provision enablers for a provision.
Parameters	`osid.id.Id[]`	`provisionEnablerIds`	the `Ids` for a set of `ProvisionEnablers`
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
Errors	NOT_FOUND		`provisionEnablerId, provisionId`, or `referenceId` not found or, `provisionEnablerId` or `referenceId` not related to `provisionId`
	NULL_ARGUMENT		`provisionEnablerIds, provisionId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.