public interface PriceEnablerStoreSession extends OsidSession
This session provides methods to retrieve PriceEnabler
to Store
mappings. A PriceEnabler
may appear
in multiple Store
objects. Each store may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPriceEnablerStoreMappings()
Tests if this user can perform lookups of price enabler/store
mappings.
|
IdList |
getPriceEnablerIdsByStore(Id storeId)
Gets the list of
PriceEnablerIds associated with an
Store. |
IdList |
getPriceEnablerIdsByStores(IdList storeIds)
Gets the list of
PriceEnabler Ids corresponding to a
list of Stores. |
PriceEnablerList |
getPriceEnablersByStore(Id storeId)
Gets the list of price enablers associated with an
Store. |
PriceEnablerList |
getPriceEnablersByStores(IdList storeIds)
Gets the list of price enablers corresponding to a list of
Stores. |
IdList |
getStoreIdsByPriceEnabler(Id priceEnablerId)
Gets the
Store Ids mapped to a
PriceEnabler. |
StoreList |
getStoresByPriceEnabler(Id priceEnablerId)
Gets the
Stores mapped to a PriceEnabler. |
void |
useComparativePriceEnablerStoreView()
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 |
usePlenaryPriceEnablerStoreView()
A complete view of the
PriceEnabler and Store
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPriceEnablerStoreMappings()
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 useComparativePriceEnablerStoreView()
mandatory
- This method is must be implemented. void usePlenaryPriceEnablerStoreView()
PriceEnabler
and Store
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. IdList getPriceEnablerIdsByStore(Id storeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceEnablerIds
associated with an
Store.
storeId
- Id
of the Store
Ids
NotFoundException
- storeId
is not foundNullArgumentException
- storeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceEnablerList getPriceEnablersByStore(Id storeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Store.
storeId
- Id
of the Store
NotFoundException
- storeId
is not foundNullArgumentException
- storeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPriceEnablerIdsByStores(IdList storeIds) throws OperationFailedException, PermissionDeniedException
PriceEnabler Ids
corresponding to a
list of Stores.
storeIds
- list of store Ids
Ids
NullArgumentException
- storeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceEnablerList getPriceEnablersByStores(IdList storeIds) throws OperationFailedException, PermissionDeniedException
Stores.
storeIds
- list of store Ids
NullArgumentException
- storeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getStoreIdsByPriceEnabler(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Store
Ids
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. StoreList getStoresByPriceEnabler(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Stores
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.