public interface InventorySearchSession extends InventoryQuerySession
This session provides methods for searching among Inventory
objects. The search query is constructed using the
InventoryQuery.
getInventoriesByQuery()
is the basic search method and
returns a list of Inventorys.
A more advanced search may be
performed with getInventorysBySearch().
It accepts an
InventorySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getInventoriesBySearch()
returns an
InventorySearchResults
that can be used to access the resulting
InventoryList
or be used to perform a search within the
result set through InventorySearch.
This session defines views that offer differing behaviors for searching.
Inventories may have a query record indicated by their respective
record types. The query record is accessed via the InventoryQuery.
Modifier and Type | Method and Description |
---|---|
InventorySearchResults |
getInventoriesBySearch(InventoryQuery inventoryQuery,
InventorySearch inventorySearch)
Gets the search results matching the given search query using the
given search.
|
InventoryQuery |
getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)
Gets an inventory query from an inspector.
|
InventorySearch |
getInventorySearch()
Gets an inventory search.
|
InventorySearchOrder |
getInventorySearchOrder()
Gets an inventory search order.
|
canSearchInventories, getInventoriesByQuery, getInventoryQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InventorySearch getInventorySearch()
mandatory
- This method must be implemented. InventorySearchOrder getInventorySearchOrder()
InventorySearchOrder
is supplied to an InventorySearch
to specify
the ordering of results.mandatory
- This method must be implemented. InventorySearchResults getInventoriesBySearch(InventoryQuery inventoryQuery, InventorySearch inventorySearch) throws OperationFailedException, PermissionDeniedException
inventoryQuery
- the inventory queryinventorySearch
- the inventory searchNullArgumentException
- inventoryQuery
or inventorySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inventoryQuery
or
inventorySearch
is not of this servicemandatory
- This method must be implemented. InventoryQuery getInventoryQueryFromInspector(InventoryQueryInspector inventoryQueryInspector)
InventorySearchResults.
inventoryQueryInspector
- an inventory query inspectorNullArgumentException
- inventoryQueryInspector
is null
UnsupportedException
- inventoryQueryInspector
is not of this servicemandatory
- This method must be implemented.