public interface StockSearchSession extends StockQuerySession
This session provides methods for searching among Stock
objects. The search query is constructed using the StockQuery.
getStocksByQuery()
is the basic search method and
returns a list of Stocks.
A more advanced search may be
performed with getStocksBySearch().
It accepts a
StockSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getStocksBySearch()
returns a StockSearchResults
that can be used to access the resulting StockList
or be
used to perform a search within the result set through StockSearch.
This session defines views that offer differing behaviors for searching.
Stocks may have a query record indicated by their respective record
types. The queryrecord is accessed via the StockQuery.
Modifier and Type | Method and Description |
---|---|
StockQuery |
getStockQueryFromInspector(ItemQueryInspector stockQueryInspector)
Gets a stock query from an inspector.
|
StockSearchResults |
getStocksBySearch(StockQuery stockQuery,
StockSearch stockSearch)
Gets the search results matching the given search query using the
given search.
|
StockSearch |
getStockSearch()
Gets a stock search.
|
StockSearchOrder |
getStockSearchOrder()
Gets a stock search order.
|
canSearchStocks, getStockQuery, getStocksByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
StockSearch getStockSearch()
mandatory
- This method must be implemented. StockSearchOrder getStockSearchOrder()
StockSearchOrder
is
supplied to a StockSearch
to specify the ordering of
results.mandatory
- This method must be implemented. StockSearchResults getStocksBySearch(StockQuery stockQuery, StockSearch stockSearch) throws OperationFailedException, PermissionDeniedException
stockQuery
- the stock querystockSearch
- the stock searchNullArgumentException
- stockQuery
or
stockSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stockQuery
or
stockSearch
is not of this servicemandatory
- This method must be implemented. StockQuery getStockQueryFromInspector(ItemQueryInspector stockQueryInspector)
StockSearchResults.
stockQueryInspector
- a stock query inspectorNullArgumentException
- stockQueryInspector
is null
UnsupportedException
- stockQueryInspector
is not of this servicemandatory
- This method must be implemented.