public interface ItemSearchSession extends ItemQuerySession
This session provides methods for searching among Item
objects. The search query is constructed using the ItemQuery.
getItemsByQuery()
is the basic search method and
returns a list of Items.
A more advanced search may be
performed with getItemsBySearch().
It accepts an
ItemSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getItemsBySearch()
returns an ItemSearchResults
that can be used to access the resulting ItemList
or be
used to perform a search within the result set through ItemSearch.
This session defines views that offer differing behaviors for searching.
Items may have a query record indicated by their respective record
types. The query record is accessed via the ItemQuery.
Modifier and Type | Method and Description |
---|---|
ItemQuery |
getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)
Gets an item query from an inspector.
|
ItemSearchResults |
getItemsBySearch(ItemQuery itemQuery,
ItemSearch itemSearch)
Gets the search results matching the given search query using the
given search.
|
ItemSearch |
getItemSearch()
Gets an item search.
|
ItemSearchOrder |
getItemSearchOrder()
Gets an inventory search order.
|
canSearchItems, getItemQuery, getItemsByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ItemSearch getItemSearch()
mandatory
- This method must be implemented. ItemSearchOrder getItemSearchOrder()
ItemSearchOrder
is
supplied to an ItemSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ItemSearchResults getItemsBySearch(ItemQuery itemQuery, ItemSearch itemSearch) throws OperationFailedException, PermissionDeniedException
itemQuery
- the item queryitemSearch
- the item searchNullArgumentException
- itemQuery
or
itemSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- itemQuery
or
itemSearch
is not of this servicemandatory
- This method must be implemented. ItemQuery getItemQueryFromInspector(ItemQueryInspector itemQueryInspector)
ItemSearchResults.
itemQueryInspector
- an item query inspectorNullArgumentException
- itemQueryInspector
is null
UnsupportedException
- itemQueryInspector
is not of this servicemandatory
- This method must be implemented.