public interface PriceEnablerSmartStoreSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
stores. A PriceEnablerQuery
can be retrieved from this
session and mapped to this Store
to create a virtual
collection of price enablers. The price enablers may be sequenced using
the PriceEnablerSearchOrder
from this session.
This Store
has a default query that matches any price
enabler and a default search order that specifies no sequencing. The
queries may be examined using a PriceEnablerQueryInspector.
The query may be modified by converting the inspector back to a
PriceEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPriceEnablerQuery(PriceEnablerQuery priceEnablerQuery)
Applies a price enabler query to this store.
|
void |
applyPriceEnablerSequencing(PriceEnablerSearchOrder priceEnablerSearchOrder)
Applies a price enabler search order to this store.
|
boolean |
canManageSmartStores()
Tests if this user can manage smart stores.
|
PriceEnablerQuery |
getPriceEnablerQuery()
Gets a price enabler query.
|
PriceEnablerQuery |
getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)
Gets a price enabler query from an inspector.
|
PriceEnablerSearchOrder |
getPriceEnablerSearchOrder()
Gets a price enabler search order.
|
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
PriceEnablerQueryInspector |
inspectPriceEnablerQuery()
Gets a price enabler query inspector for this store.
|
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 canManageSmartStores()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart store management is not
authorized, true
otherwisemandatory
- This method must be implemented. PriceEnablerQuery getPriceEnablerQuery()
mandatory
- This method must be implemented. PriceEnablerSearchOrder getPriceEnablerSearchOrder()
mandatory
- This method must be implemented. void applyPriceEnablerQuery(PriceEnablerQuery priceEnablerQuery) throws OperationFailedException, PermissionDeniedException
priceEnablerQuery
- the price enabler queryNullArgumentException
- priceEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- priceEnablerQuery
not of this servicemandatory
- This method must be implemented. PriceEnablerQueryInspector inspectPriceEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPriceEnablerSequencing(PriceEnablerSearchOrder priceEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
priceEnablerSearchOrder
- the price enabler search orderNullArgumentException
- priceEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- priceEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. PriceEnablerQuery getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)
priceEnablerQueryInspector
- a price enabler query inspectorNullArgumentException
-
priceEnablerQueryInspector
is null
UnsupportedException
-
priceEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.