public interface WarehouseSearchSession extends WarehouseQuerySession
This session provides methods for searching among Warehouse
objects. The search query is constructed using the
WarehouseQuery.
getWarehousesByQuery()
is the basic search method and
returns a list of Warehouses.
A more advanced search may be
performed with getWarehousesBySearch().
It accepts a
WarehouseSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getWarehousesBySearch()
returns a
WarehouseSearchResults
that can be used to access the resulting
WarehouseList
or be used to perform a search within the
result set through Warehousesearch.
This session defines views that offer differing behaviors for searching.
warehouses may have a query record indicated by their respective
record types. The query record is accessed via the WarehouseQuery.
Modifier and Type | Method and Description |
---|---|
WarehouseQuery |
getWarehouseQueryFromInspector(WarehouseQueryInspector warehouseQueryInspector)
Gets a warehouse query from an inspector.
|
WarehouseSearchResults |
getWarehousesBySearch(WarehouseQuery warehouseQuery,
WarehouseSearch warehouseSearch)
Gets the search results matching the given search query using the
given search.
|
WarehouseSearch |
getWarehouseSearch()
Gets a warehouse search.
|
WarehouseSearchOrder |
getWarehouseSearchOrder()
Gets a warehouse search order.
|
canSearchWarehouses, getWarehouseQuery, getWarehousesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
WarehouseSearch getWarehouseSearch()
mandatory
- This method must be implemented. WarehouseSearchOrder getWarehouseSearchOrder()
WarehouseSearchOrder
is supplied to a WarehouseSearch
to specify the
ordering of results.mandatory
- This method must be implemented. WarehouseSearchResults getWarehousesBySearch(WarehouseQuery warehouseQuery, WarehouseSearch warehouseSearch) throws OperationFailedException, PermissionDeniedException
warehouseQuery
- the warehouse querywarehouseSearch
- the warehouse searchNullArgumentException
- warehouseQuery
or warehouseSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- warehouseQuery
or
warehouseSearch
is not of this servicemandatory
- This method must be implemented. WarehouseQuery getWarehouseQueryFromInspector(WarehouseQueryInspector warehouseQueryInspector)
WarehousesearchResults.
warehouseQueryInspector
- a warehouse query inspectorNullArgumentException
- warehouseQueryInspector
is null
UnsupportedException
- warehouseQueryInspector
is not of this servicemandatory
- This method must be implemented.