public interface PriceEnablerSearchSession extends PriceEnablerQuerySession
This session provides methods for searching among PriceEnabler
objects. The search query is constructed using the
PriceEnableryQuery.
getPriceEnablersByQuery()
is the basic search method
and returns a list of PriceEnablers.
A more advanced search
may be performed with getPriceEnablersBySearch().
It
accepts a PriceEnablerSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getPriceEnablersBySearch()
returns a
PriceEnablerSearchResults
that can be used to access the
resulting PriceEnablerList
or be used to perform a search
within the result set through PriceEnablerSearch.
This session defines views that offer differing behaviors for searching.
PriceEnablers
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 |
---|---|
PriceEnablerQuery |
getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)
Gets a price enabler query from an inspector.
|
PriceEnablerSearchResults |
getPriceEnablersBySearch(PriceEnablerQuery priceEnablerQuery,
PriceEnablerSearch priceEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
PriceEnablerSearch |
getPriceEnablerSearch()
Gets a price enabler search.
|
PriceEnablerSearchOrder |
getPriceEnablerSearchOrder()
Gets a price enabler search order.
|
canSearchPriceEnablers, getPriceEnablerQuery, getPriceEnablersByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PriceEnablerSearch getPriceEnablerSearch()
mandatory
- This method must be implemented. PriceEnablerSearchOrder getPriceEnablerSearchOrder()
PriceEnablerSearchOrder
is supplied to a PriceEnablerSearch
to specify
the ordering of results.mandatory
- This method must be implemented. PriceEnablerSearchResults getPriceEnablersBySearch(PriceEnablerQuery priceEnablerQuery, PriceEnablerSearch priceEnablerSearch) throws OperationFailedException, PermissionDeniedException
priceEnablerQuery
- the price enabler querypriceEnablerSearch
- the price enabler searchNullArgumentException
- priceEnablerQuery
or priceEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- priceEnablerQuery
or priceEnablerSearch
is not of this servicemandatory
- This method must be implemented. PriceEnablerQuery getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)
PriceEnablerSearchResults.
priceEnablerQueryInspector
- a price enabler query inspectorNullArgumentException
-
priceEnablerQueryInspector
is null
UnsupportedException
-
priceEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.