public interface PriceScheduleStoreSession extends OsidSession
This session provides methods to retrieve PriceSchedule
to Store
mappings. A PriceSchedule
may
appear in multiple Stores.
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 |
canLookupPriceScheduleStoreMappings()
Tests if this user can perform lookups of price schedule/store
mappings.
|
IdList |
getPriceScheduleIdsByStore(Id storeId)
Gets the list of
PriceSchedule Ids
associated with a Store. |
IdList |
getPriceScheduleIdsByStores(IdList storeIds)
Gets the list of
PriceSchedule Ids corresponding to a
list of Store objects. |
PriceScheduleList |
getPriceSchedulesByStore(Id storeId)
Gets the list of
PriceSchedules associated with a
Store. |
PriceScheduleList |
getPriceSchedulesByStores(IdList storeIds)
Gets the list of
PriceSchedules corresponding to a list
of Stores. |
IdList |
getStoreIdsByPriceSchedule(Id priceScheduleId)
Gets the list of
Store Ids mapped to a
PriceSchedule. |
StoreList |
getStoresByPriceSchedule(Id priceScheduleId)
Gets the list of
Store objects mapped to a
PriceSchedule. |
void |
useComparativeStoreView()
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 |
usePlenaryStoreView()
A complete view of the
PriceSchedule and Store
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPriceScheduleStoreMappings()
PERMISSION_DENIED.
This is intendedas 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 useComparativeStoreView()
mandatory
- This method is must be implemented. void usePlenaryStoreView()
PriceSchedule
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 getPriceScheduleIdsByStore(Id storeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceSchedule
Ids
associated with a Store.
storeId
- Id
of a Store.
Ids
NotFoundException
- storeId
is not foundNullArgumentException
- storeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedulesByStore(Id storeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceSchedules
associated with a
Store.
storeId
- Id
of a Store
NotFoundException
- storeId
is not foundNullArgumentException
- storeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPriceScheduleIdsByStores(IdList storeIds) throws OperationFailedException, PermissionDeniedException
PriceSchedule Ids
corresponding to a
list of Store
objects.storeIds
- list of store Ids
Ids
NullArgumentException
- storeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedulesByStores(IdList storeIds) throws OperationFailedException, PermissionDeniedException
PriceSchedules
corresponding to a list
of Stores.
storeIds
- list of store Ids
NullArgumentException
- storeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getStoreIdsByPriceSchedule(Id priceScheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Store
Ids
mapped to a
PriceSchedule.
priceScheduleId
- Id
of a PriceSchedule
Ids
NotFoundException
- priceScheduleId
is
not foundNullArgumentException
- priceScheduleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StoreList getStoresByPriceSchedule(Id priceScheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Store
objects mapped to a
PriceSchedule.
priceScheduleId
- Id
of a PriceSchedule
NotFoundException
- priceScheduleId
is
not foundNullArgumentException
- priceScheduleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.