Interface ShipmentSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ShipmentQuerySession

public interface ShipmentSearchSession
extends ShipmentQuerySession

This session provides methods for searching among Shipments . 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.

• federated warehouse view: searches include shipments in warehouses of which this warehouse is an ancestor in the warehouse hierarchy
• isolated warehouse view: searches are restricted to shipments in this warehouse

Shipments may have a query record indicated by their respective record types. The query record is accessed via the ShipmentQuery .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface ShipmentQuerySession

canSearchShipments, getShipmentQuery, getShipmentsByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView

Modifier and Type	Method	Description
boolean	canSearchShipments()	Tests if this user can perform Shipment searches.
ShipmentQuery	getShipmentQuery()	Gets a shipment query.
ShipmentList	getShipmentsByQuery(ShipmentQuery shipmentQuery)	Gets a list of Shipments matching the given shipment query.
Warehouse	getWarehouse()	Gets the Warehouse associated with this session.
Id	getWarehouseId()	Gets the Warehouse Id associated with this session.
void	useFederatedWarehouseView()	Federates the view for methods in this session.
void	useIsolatedWarehouseView()	Isolates the view for methods in this session.

Method Details

getShipmentSearch

ShipmentSearch getShipmentSearch()

Gets a shipment search.

Returns:

the shipment search

Compliance:

mandatory - This method must be implemented.

getShipmentSearchOrder

ShipmentSearchOrder getShipmentSearchOrder()

Gets a shipment search order. The ShipmentSearchOrder is supplied to a ShipmentSearch to specify the ordering of results.

Returns:

the shipment search order

Compliance:

mandatory - This method must be implemented.

getShipmentsBySearch

ShipmentSearchResults getShipmentsBySearch(ShipmentQuery shipmentQuery,
 ShipmentSearch shipmentSearch)
                                    throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

shipmentQuery - the shipment query

shipmentSearch - the shipment search

Returns:

the shipment search results

Throws:

NullArgumentException - shipmentQuery or shipmentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - shipmentQuery or shipmentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getShipmentQueryFromInspector

ShipmentQuery getShipmentQueryFromInspector(ShipmentQueryInspector shipmentQueryInspector)

Gets a shipment query from an inspector. The inspector is available from a ShipmentSearchResults .

Parameters:

shipmentQueryInspector - a shipment query inspector

Returns:

the shipment query

Throws:

NullArgumentException - shipmentQueryInspector is null

UnsupportedException - shipmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.