public interface PriceEnablerQuerySession extends OsidSession
This session provides methods for searching among PriceEnabler
objects. The search query is constructed using the
PriceEnablerQuery.
This session defines views that offer differing behaviors for searching.
Price enablers may have a query record indicated by their respective
record types. The query record is accessed via the
PriceEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPriceEnablers()
Tests if this user can perform
PriceEnabler lookups. |
PriceEnablerQuery |
getPriceEnablerQuery()
Gets a price enabler query.
|
PriceEnablerList |
getPriceEnablersByQuery(PriceEnablerQuery priceEnablerQuery)
Gets a list of
PriceEnablers matching the given price
enabler query. |
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
useFederatedStoreView()
Federates the view for methods in this session.
|
void |
useIsolatedStoreView()
Isolates the view for methods in this session.
|
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 canSearchPriceEnablers()
PriceEnabler
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedStoreView()
mandatory
- This method is must be implemented. void useIsolatedStoreView()
mandatory
- This method is must be implemented. PriceEnablerQuery getPriceEnablerQuery()
mandatory
- This method must be implemented. PriceEnablerList getPriceEnablersByQuery(PriceEnablerQuery priceEnablerQuery) throws OperationFailedException, PermissionDeniedException
PriceEnablers
matching the given price
enabler query.priceEnablerQuery
- the price enabler query PriceEnablerList
NullArgumentException
- priceEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- priceEnablerQuery
is not of this servicemandatory
- This method must be implemented.