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

Interface	osid.ordering.rules.PriceEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.rules.OrderingRulesManager`
Used By	`osid.ordering.rules.OrderingRulesProxyManager`
Description	This session provides methods to retrieve `PriceEnabler` to `Price` mappings. A `Price` with multiple `PriceEnablers` means any positive rule evaluation across the enablers result in an effective `Price`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated store view: All methods in this session operate, retrieve and pertain price enablers defined explicitly in the current store federated store view: All methods in this session operate, retrieve and pertain to all price enablers defined in this store and any other price enablers implicitly available in this store through store inheritence.
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	canLookupPriceEnablerPriceMappings
Description	Tests if this user can perform lookups of price enabler/price mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePriceEnablerPriceView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryPriceEnablerPriceView
Description	A complete view of the `PriceEnabler` and `Price` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include price enablers in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedStoreView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPriceEnablerIdsForPrice
Description	Gets the `PriceEnabler Id` associated with a `Price`.
Parameters	`osid.id.Id`	`priceId`	`Id` of the `Price`
Return	`osid.id.IdList`		the price enabler `Ids`
Errors	NOT_FOUND		`priceId` is not found
	NULL_ARGUMENT		`priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersForPrice
Description	Gets the `PriceEnabler` associated with a `Price`.
Parameters	`osid.id.Id`	`priceId`	`Id` of the `Price`
Return	`osid.ordering.rules.PriceEnablerList`		the price enablers
Errors	NOT_FOUND		`priceId` is not found
	NULL_ARGUMENT		`priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablersForPriceOnDate
Description	Gets the `PriceEnablers` associated with a `Price` and the given date is within the effective dates inclusive.
Parameters	`osid.id.Id`	`priceId`	`Id` of the `Price`
Parameters	`osid.calendaring.DateTime`	`date`	a date
Return	`osid.ordering.rules.PriceEnablerList`		the price enablers
Errors	NOT_FOUND		`priceId` is not found
	NULL_ARGUMENT		`priceId` or `date` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPriceIdsByPriceEnabler
Description	Gets the `Price` `Ids` mapped to a `PriceEnabler`.
Parameters	`osid.id.Id`	`priceEnablerId`	`Id` of a `PriceEnabler`
Return	`osid.id.IdList`		list of price `Ids`
Errors	NOT_FOUND		`priceEnablerId` is not found
	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPricesByPriceEnabler
Description	Gets the `Prices` mapped to a `PriceEnabler`.
Parameters	`osid.id.Id`	`priceEnablerId`	`Id` of a `PriceEnabler`
Return	`osid.ordering.PriceList`		list of prices
Errors	NOT_FOUND		`priceEnablerId` is not found
	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.