Interface ShipmentWarehouseSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ShipmentWarehouseSession
extends OsidSession

This session provides methods to retrieve Shipment to Warehouse mappings. A Shipment may appear in multiple Warehouse objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupShipmentWarehouseMappings()	Tests if this user can perform lookups of shipment/warehouse mappings.
IdList	getShipmentIdsByWarehouse(Id warehouseId)	Gets the list of Shipment Ids associated with a Warehouse .
IdList	getShipmentIdsByWarehouses(IdList warehouseIds)	Gets the list of Shipment Ids corresponding to a list of Warehouse objects.
ShipmentList	getShipmentsByWarehouse(Id warehouseId)	Gets the list of Shipments associated with a Warehouse .
ShipmentList	getShipmentsByWarehouses(IdList warehouseIds)	Gets the list of Shipments corresponding to a list of Warehouse objects.
IdList	getWarehouseIdsByShipment(Id shipmentId)	Gets the Warehouse Ids mapped to a Shipment .
WarehouseList	getWarehousesByShipment(Id shipmentId)	Gets the Warehouse objects mapped to a Shipment .
void	useComparativeShipmentWarehouseView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryShipmentWarehouseView()	A complete view of the Shipment and Warehouse returns is desired.

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.

Method Details

canLookupShipmentWarehouseMappings

boolean canLookupShipmentWarehouseMappings()

Tests if this user can perform lookups of shipment/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeShipmentWarehouseView

void useComparativeShipmentWarehouseView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryShipmentWarehouseView

void usePlenaryShipmentWarehouseView()

A complete view of the Shipment and Warehouse returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getShipmentIdsByWarehouse

IdList getShipmentIdsByWarehouse(Id warehouseId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Shipment Ids associated with a Warehouse .

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related shipment Ids

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getShipmentsByWarehouse

ShipmentList getShipmentsByWarehouse(Id warehouseId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Shipments associated with a Warehouse .

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related shipments

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getShipmentIdsByWarehouses

IdList getShipmentIdsByWarehouses(IdList warehouseIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Shipment Ids corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of shipment Ids

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getShipmentsByWarehouses

ShipmentList getShipmentsByWarehouses(IdList warehouseIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of Shipments corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of shipments

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseIdsByShipment

IdList getWarehouseIdsByShipment(Id shipmentId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Warehouse Ids mapped to a Shipment .

Parameters:

shipmentId - Id of a Shipment

Returns:

list of warehouse Ids

Throws:

NotFoundException - shipmentId is not found

NullArgumentException - shipmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehousesByShipment

WarehouseList getWarehousesByShipment(Id shipmentId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Warehouse objects mapped to a Shipment .

Parameters:

shipmentId - Id of a Shipment

Returns:

list of warehouses

Throws:

NotFoundException - shipmentId is not found

NullArgumentException - shipmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.