public interface OrderSmartStoreSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An OrderQuery
can be retrieved from this session
and mapped to this Store
to create a virtual collection of
Orders.
The orders may be sequenced using the
OrderSearchOrder
from this session.
This Store
has a default query that matches any order
and a default search order that specifies no sequencing. The queries may
be examined using an OrderQueryInspector.
The query may be
modified by converting the inspector back to an OrderQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyOrderQuery(OrderQuery orderQuery)
Applies an order query to this store.
|
void |
applyOrderSequencing(OrderSearchOrder orderSearchOrder)
Applies an order search order to this store.
|
boolean |
canManageSmartStores()
Tests if this user can manage smart stores.
|
OrderQuery |
getOrderQuery()
Gets an order query.
|
OrderQuery |
getOrderQueryFromInspector(OrderQueryInspector orderQueryInspector)
Gets an order query from an inspector.
|
OrderSearchOrder |
getOrderSearchOrder()
Gets an order search order.
|
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
OrderQueryInspector |
inspectOrderQuery()
Gets an order 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. OrderQuery getOrderQuery()
mandatory
- This method must be implemented. OrderSearchOrder getOrderSearchOrder()
mandatory
- This method must be implemented. void applyOrderQuery(OrderQuery orderQuery) throws OperationFailedException, PermissionDeniedException
orderQuery
- the order queryNullArgumentException
- orderQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- orderQuery
not of
this servicemandatory
- This method must be implemented. OrderQueryInspector inspectOrderQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyOrderSequencing(OrderSearchOrder orderSearchOrder) throws OperationFailedException, PermissionDeniedException
orderSearchOrder
- the order search orderNullArgumentException
- orderSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- orderSearchOrder
not of this servicemandatory
- This method must be implemented. OrderQuery getOrderQueryFromInspector(OrderQueryInspector orderQueryInspector)
orderQueryInspector
- a query inspectorNullArgumentException
- orderQueryInspector
is null
UnsupportedException
- orderQueryInspector
is not of this servicemandatory
- This method must be implemented.