public interface ProductSearchSession extends ProductQuerySession
This session provides methods for searching Product
objects. The search query is constructed using the ProductQuery.
The product record Type
also specifies the record
for the product query.
getProductsByQuery()
is the basic search method and
returns a list of Product
elements. A more advanced search
may be performed with getProductsBySearch().
It accepts a
ProductSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getProductsBySearch()
returns a
ProductSearchResults
that can be used to access the resulting
ProductList
or be used to perform a search within the
result set through ProductSearch.
Products may have a query record indicated by their respective record
types. The query record is accessed via the ProductQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ProductQuery |
getProductQueryFromInspector(ProductQueryInspector productQueryInspector)
Gets a product query from an inspector.
|
ProductSearchResults |
getProductsBySearch(ProductQuery productQuery,
ProductSearch productSearch)
Gets the search results matching the given search.
|
ProductSearch |
getProductSearch()
Gets a product search.
|
ProductSearchOrder |
getProductSearchOrder()
Gets a product search order.
|
canSearchProducts, getProductQuery, getProductsByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProductSearch getProductSearch()
mandatory
- This method must be implemented. ProductSearchOrder getProductSearchOrder()
ProductSearchOrder
is
supplied to a ProductSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ProductSearchResults getProductsBySearch(ProductQuery productQuery, ProductSearch productSearch) throws OperationFailedException, PermissionDeniedException
productQuery
- the product queryproductSearch
- the product searchNullArgumentException
- productQuery
or
productSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- productQuery
or
productSearch
is not of this servicemandatory
- This method must be implemented. ProductQuery getProductQueryFromInspector(ProductQueryInspector productQueryInspector)
ProductSearchResults.
productQueryInspector
- a query inspectorNullArgumentException
- productQueryInspector
is null
UnsupportedException
- productQueryInspector
is not of this servicemandatory
- This method must be implemented.