org.osid.inventory.shipment

Interface ShipmentSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ShipmentQuerySession

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.

• 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

Methods

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.

Methods inherited from interface org.osid.inventory.shipment.ShipmentQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.