public interface ShipmentSearchSession extends ShipmentQuerySession
This session provides methods for searching among Shipment
objects. The search query is constructed using the
ShipmentQuery.
getShipmentsByQuery()
is the basic search method and
returns a list of Shipments.
A more advanced search may be
performed with getShipmentsBySearch().
It accepts a
ShipmentSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getShipmentsBySearch()
returns a
ShipmentSearchResults
that can be used to access the resulting
ShipmentList
or be used to perform a search within the
result set through ShipmentSearch.
This session defines views that offer differing behaviors for searching.
Shipments may have a query record indicated by their respective record
types. The query record is accessed via the ShipmentQuery.
Modifier and Type | Method and Description |
---|---|
ShipmentQuery |
getShipmentQueryFromInspector(ShipmentQueryInspector shipmentQueryInspector)
Gets a shipment query from an inspector.
|
ShipmentSearchResults |
getShipmentsBySearch(ShipmentQuery shipmentQuery,
ShipmentSearch shipmentSearch)
Gets the search results matching the given search query using the
given search.
|
ShipmentSearch |
getShipmentSearch()
Gets a shipment search.
|
ShipmentSearchOrder |
getShipmentSearchOrder()
Gets a shipment search order.
|
canSearchShipments, getShipmentQuery, getShipmentsByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ShipmentSearch getShipmentSearch()
mandatory
- This method must be implemented. ShipmentSearchOrder getShipmentSearchOrder()
ShipmentSearchOrder
is supplied to a ShipmentSearch
to specify the ordering
of results.mandatory
- This method must be implemented. ShipmentSearchResults getShipmentsBySearch(ShipmentQuery shipmentQuery, ShipmentSearch shipmentSearch) throws OperationFailedException, PermissionDeniedException
shipmentQuery
- the shipment queryshipmentSearch
- the shipment searchNullArgumentException
- shipmentQuery
or
shipmentSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- shipmentQuery
or
shipmentSearch
is not of this servicemandatory
- This method must be implemented. ShipmentQuery getShipmentQueryFromInspector(ShipmentQueryInspector shipmentQueryInspector)
ShipmentSearchResults.
shipmentQueryInspector
- a shipment query inspectorNullArgumentException
- shipmentQueryInspector
is null
UnsupportedException
- shipmentQueryInspector
is not of this servicemandatory
- This method must be implemented.