org.osid.inventory.shipment

Interface ShipmentQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ShipmentSearchSession

public interface ShipmentQuerySession
extends OsidSession

This session provides methods for searching among Shipment objects. The search query is constructed using the ShipmentQuery.

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
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.

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

getWarehouseId

Id getWarehouseId()

Gets the Warehouse Id associated with this session.

Returns:

the Warehouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getWarehouse

Warehouse getWarehouse()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Warehouse associated with this session.

Returns:

the warehouse

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchShipments

boolean canSearchShipments()

Tests if this user can perform Shipment searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedWarehouseView

void useFederatedWarehouseView()

Federates the view for methods in this session. A federated view will include shipments in warehouse which are children of this warehouse in the warehouse hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedWarehouseView

void useIsolatedWarehouseView()

Isolates the view for methods in this session. An isolated view restricts lookups to this warehouse only.

Compliance:

mandatory - This method is must be implemented.

getShipmentQuery

ShipmentQuery getShipmentQuery()

Gets a shipment query.

Returns:

the shipment query

Compliance:

mandatory - This method must be implemented.

getShipmentsByQuery

ShipmentList getShipmentsByQuery(ShipmentQuery shipmentQuery)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a list of Shipments matching the given shipment query.

Parameters:

shipmentQuery - the shipment query

Returns:

the returned ShipmentList

Throws:

NullArgumentException - shipmentQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - shipmentQuery is not of this service

Compliance:

mandatory - This method must be implemented.