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:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupShipmentWarehouseMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeShipmentWarehouseView()
mandatory
- This method is must be implemented. void usePlenaryShipmentWarehouseView()
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.mandatory
- This method is must be implemented. IdList getShipmentIdsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Shipment Ids
associated with a
Warehouse.
warehouseId
- Id
of the Warehouse
Ids
NotFoundException
- warehouseId
is not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Shipments
associated with a
Warehouse.
warehouseId
- Id
of the Warehouse
NotFoundException
- warehouseId
is not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getShipmentIdsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Shipment Ids
corresponding to a list
of Warehouse
objects.warehouseIds
- list of warehouse Ids
Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentList getShipmentsByWarehouses(IdList warehouseIds) throws OperationFailedException, PermissionDeniedException
Shipments
corresponding to a list of
Warehouse
objects.warehouseIds
- list of warehouse Ids
NullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getWarehouseIdsByShipment(Id shipmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
Ids
mapped to a
Shipment.
shipmentId
- Id
of a Shipment
Ids
NotFoundException
- shipmentId
is not
foundNullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByShipment(Id shipmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
objects mapped to a Shipment.
shipmentId
- Id
of a Shipment
NotFoundException
- shipmentId
is not
foundNullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.