OSID Logo
OSID Specifications
ordering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.rules.PriceEnablerRuleLookupSession
Implementsosid.OsidSession
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.
MethodgetStoreId
Description

Gets the Store Id associated with this session.

Returnosid.id.Idthe Store Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetStore
Description

Gets the Store associated with this session.

Returnosid.ordering.Storethe store
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupPriceEnablerPriceMappings
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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePriceEnablerPriceView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryPriceEnablerPriceView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedStoreView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedStoreView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this store only.

CompliancemandatoryThis method is must be implemented.
MethodgetPriceEnablerIdsForPrice
Description

Gets the PriceEnabler Id associated with a Price.

Parametersosid.id.Id priceId Id of the Price
Returnosid.id.IdListthe price enabler Ids
ErrorsNOT_FOUND priceId is not found
NULL_ARGUMENT priceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablersForPrice
Description

Gets the PriceEnabler associated with a Price.

Parametersosid.id.IdpriceId Id of the Price
Returnosid.ordering.rules.PriceEnablerListthe price enablers
ErrorsNOT_FOUND priceId is not found
NULL_ARGUMENT priceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPriceIdsByPriceEnabler
Description

Gets the Price Ids mapped to a PriceEnabler.

Parametersosid.id.IdpriceEnablerId Id of a PriceEnabler
Returnosid.id.IdListlist of price Ids
ErrorsNOT_FOUND priceEnablerId is not found
NULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPricesByPriceEnabler
Description

Gets the Prices mapped to a PriceEnabler.

Parametersosid.id.IdpriceEnablerId Id of a PriceEnabler
Returnosid.ordering.PriceListlist of prices
ErrorsNOT_FOUND priceEnablerId is not found
NULL_ARGUMENT priceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.