public interface PriceScheduleSmartStoreSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PriceScheduleQuery
can be retrieved from this
session and mapped to this Store
to create a virtual
collection of PriceSchedules.
The prices may be sequenced
using the PriceScheduleSearchOrder
from this session.
This Store
has a default query that matches any price
schedule and a default search order that specifies no sequencing. The
queries may be examined using a PriceScheduleQueryInspector.
The query may be modified by converting the inspector back to a
PriceScheduleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPriceScheduleQuery(PriceScheduleQuery priceQuery)
Applies a price schedule query to this store.
|
void |
applyPriceScheduleSequencing(PriceScheduleSearchOrder priceScheduleSearchOrder)
Applies a price schedule search order to this store.
|
boolean |
canManageSmartStores()
Tests if this user can manage smart stores.
|
PriceScheduleQuery |
getPriceScheduleQuery()
Gets a price schedule query.
|
PriceScheduleQuery |
getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)
Gets a price schedule query from an inspector.
|
PriceScheduleSearchOrder |
getPriceScheduleSearchOrder()
Gets a price schedule search order.
|
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
PriceScheduleQueryInspector |
inspectPriceScheduleQuery()
Gets a price schedule 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. Store
associated with this sessionOperationFailedException
- 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. PriceScheduleQuery getPriceScheduleQuery()
mandatory
- This method must be implemented. PriceScheduleSearchOrder getPriceScheduleSearchOrder()
mandatory
- This method must be implemented. void applyPriceScheduleQuery(PriceScheduleQuery priceQuery) throws OperationFailedException, PermissionDeniedException
priceQuery
- the price schedule queryNullArgumentException
- priceScheduleQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- priceScheduleQuery
not of this servicemandatory
- This method must be implemented. PriceScheduleQueryInspector inspectPriceScheduleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPriceScheduleSequencing(PriceScheduleSearchOrder priceScheduleSearchOrder) throws OperationFailedException, PermissionDeniedException
priceScheduleSearchOrder
- the price schedule search orderNullArgumentException
- priceScheduleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- priceScheduleSearchOrder
not of this servicemandatory
- This method must be implemented. PriceScheduleQuery getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)
priceScheduleQueryInspector
- a query inspectorNullArgumentException
-
priceScheduleQueryInspector
is null
UnsupportedException
-
priceScheduleQueryInspector
is not of this servicemandatory
- This method must be implemented.