OSID - osid.ordering.rules.PriceEnablerRuleApplicationSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `PriceEnablers` to `Prices.` A `Price` with multiple `PriceEnablers` means any positive rule evaluation across the enablers result in an effective `Price.`
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignPriceEnablers
Description	Tests if this user can alter price enabler/price 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	assignPriceEnablerToPrice
Description	Adds an existing `PriceEnabler` to a `Price.`
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler`
Parameters	`osid.id.Id`	`priceId`	the `Id` of the `Price`
Errors	ALREADY_EXISTS		`priceEnablerId` is already applied to `priceId`
	NOT_FOUND		`priceEnablerId` or `priceId` not found
	NULL_ARGUMENT		`priceEnablerId` or `priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPriceEnablerFromPrice
Description	Removes a `PriceEnabler` from a `Price.`
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler`
Parameters	`osid.id.Id`	`priceId`	the `Id` of the `Price`
Errors	NOT_FOUND		`priceEnablerId` or `priceId` not found or `priceEnablerId` is not applied to `priceId`
	NULL_ARGUMENT		`priceEnablerId` or `priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequencePriceEnablers
Description	Tests if this user can order `ProceEnablers.` 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 `PriceEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	movePriceEnablerAhead
Description	Reorders price enablers for a price by moving the specified price enabler in front of a reference price enabler.
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of a `PriceEnabler`
	`osid.id.Id`	`priceId`	the `Id` of a `Price`
	`osid.id.Id`	`referenceId`	the reference price enabler `Id`
Errors	NOT_FOUND		`priceEnablerId, priceId,` or `referenceId` not found or, `priceEnablerId` or `referenceId` not related to `priceId`
	NULL_ARGUMENT		`priceEnablerId, priceId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	movePriceEnablerBehind
Description	Reorders price enablers for a price by moving the specified price enabler behind a reference price enabler.
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of a `PriceEnabler`
	`osid.id.Id`	`priceId`	the `Id` of a `Price`
	`osid.id.Id`	`referenceId`	the reference price enabler `Id`
Errors	NOT_FOUND		`priceEnablerId, priceId,` or `referenceId` not found or, `priceEnablerId` or `referenceId` not related to `priceId`
	NULL_ARGUMENT		`priceEnablerId, priceId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderPriceEnablers
Description	Reorders a set of price enablers for an price.
Parameters	`osid.id.Id[]`	`priceEnablerIds`	the `Ids` for a set of `PriceEnablers`
Parameters	`osid.id.Id`	`priceId`	the `Id` of a `Price`
Errors	NOT_FOUND		`priceId` not found or, a `priceEnablerId` not related to `priceId`
	NULL_ARGUMENT		`priceEnablerIds` or `priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.