public interface PriceEnablerRuleLookupSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPriceEnablerPriceMappings()
Tests if this user can perform lookups of price enabler/price
mappings.
|
IdList |
getPriceEnablerIdsForPrice(Id priceId)
Gets the
PriceEnabler Id associated with a
Price. |
PriceEnablerList |
getPriceEnablersForPrice(Id priceId)
Gets the
PriceEnabler associated with a Price. |
IdList |
getPriceIdsByPriceEnabler(Id priceEnablerId)
Gets the
Price Ids mapped to a
PriceEnabler. |
PriceList |
getPricesByPriceEnabler(Id priceEnablerId)
Gets the
Prices mapped to a PriceEnabler. |
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
useComparativePriceEnablerPriceView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedStoreView()
Federates the view for methods in this session.
|
void |
useIsolatedStoreView()
Isolates the view for methods in this session.
|
void |
usePlenaryPriceEnablerPriceView()
A complete view of the
PriceEnabler and Price
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getStoreId()
Store
Id
associated with this
session. Store Id
associated with this sessionmandatory
- This method must be implemented. Store getStore() throws OperationFailedException, PermissionDeniedException
Store
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupPriceEnablerPriceMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePriceEnablerPriceView()
mandatory
- This method is must be implemented. void usePlenaryPriceEnablerPriceView()
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.mandatory
- This method is must be implemented. void useFederatedStoreView()
mandatory
- This method is must be implemented. void useIsolatedStoreView()
mandatory
- This method is must be implemented. IdList getPriceEnablerIdsForPrice(Id priceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceEnabler Id
associated with a
Price.
priceId
- Id
of the Price
Ids
NotFoundException
- priceId
is not foundNullArgumentException
- priceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceEnablerList getPriceEnablersForPrice(Id priceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceEnabler
associated with a Price.
priceId
- Id
of the Price
NotFoundException
- priceId
is not foundNullArgumentException
- priceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPriceIdsByPriceEnabler(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Price
Ids
mapped to a
PriceEnabler.
priceEnablerId
- Id
of a PriceEnabler
Ids
NotFoundException
- priceEnablerId
is
not foundNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceList getPricesByPriceEnabler(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Prices
mapped to a PriceEnabler.
priceEnablerId
- Id
of a PriceEnabler
NotFoundException
- priceEnablerId
is
not foundNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.