public interface ShipmentWarehouseAssignmentSession extends OsidSession
This session provides methods to re-assign Shipments
to
Warehouse
objects A Shipment
may appear in
multiple Warehouse
objects and removing the last reference
to a Shipment
is the equivalent of deleting it. Each
Warehouse
may have its own authorizations governing who is allowed
to operate on it.
Adding a reference of a Shipment
to another
Warehouse
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignShipmentToWarehouse(Id shipmentId,
Id warehouseId)
Adds an existing
Shipment to a Warehouse. |
boolean |
canAssignShipments()
Tests if this user can alter shipment/warehouse mappings.
|
boolean |
canAssignShipmentToWarehouse(Id warehouseId)
Tests if this user can alter shipment/warehouse mappings.
|
IdList |
getAssignableWarehouseIds(Id warehouseId)
Gets a list of warehouses including and under the given warehouse node
in which any shipment can be assigned.
|
IdList |
getAssignableWarehouseIdsForShipment(Id warehouseId,
Id shipmentId)
Gets a list of warehouses including and under the given warehouse node
in which a specific shipment can be assigned.
|
void |
reassignShipmentToWarehouse(Id shipmentId,
Id fromWarehouseId,
Id toWarehouseId)
Moves a
Shipment from one Warehouse to
another. |
void |
unassignShipmentFromWarehouse(Id shipmentId,
Id warehouseId)
Removes a
Shipment from a Warehouse. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignShipments()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignShipmentToWarehouse(Id warehouseId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.warehouseId
- the Id
of the Warehouse
false
if mapping is not authorized, true
otherwiseNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. IdList getAssignableWarehouseIds(Id warehouseId) throws OperationFailedException
warehouseId
- the Id
of the Warehouse
Ids
NullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableWarehouseIdsForShipment(Id warehouseId, Id shipmentId) throws OperationFailedException
warehouseId
- the Id
of the Warehouse
shipmentId
- the Id
of the Shipment
Ids
NullArgumentException
- warehouseId
or
shipmentId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignShipmentToWarehouse(Id shipmentId, Id warehouseId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Shipment
to a Warehouse.
shipmentId
- the Id
of the Shipment
warehouseId
- the Id
of the Warehouse
AlreadyExistsException
- shipmentId
is
already assigned to warehouseId
NotFoundException
- shipmentId
or
warehouseId
not foundNullArgumentException
- shipmentId
or
warehouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignShipmentFromWarehouse(Id shipmentId, Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Shipment
from a Warehouse.
shipmentId
- the Id
of the Shipment
warehouseId
- the Id
of the Warehouse
NotFoundException
- shipmentId
or
warehouseId
not found or shipmentId
not
assigned to warehouseId
NullArgumentException
- shipmentId
or
warehouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignShipmentToWarehouse(Id shipmentId, Id fromWarehouseId, Id toWarehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Shipment
from one Warehouse
to
another. Mappings to other Warehouses
are unaffected.shipmentId
- the Id
of the Shipment
fromWarehouseId
- the Id
of the current
Warehouse
toWarehouseId
- the Id
of the destination
Warehouse
NotFoundException
- shipmentId, fromWarehouseId,
or toWarehouseId
not found or
shipmentId
not mapped to fromWarehouseId
NullArgumentException
- shipmentId,
fromWarehouseId,
or toWarehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.