OSID - osid.inventory.shipment.ShipmentWarehouseAssignmentSession Service Interface Definition

Interface	osid.inventory.shipment.ShipmentWarehouseAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session provides methods to re-assign `Shipments` to `Warehouses`. 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`).
Method	canAssignShipments
Description	Tests if this user can alter shipment/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignShipmentToWarehouse
Description	Tests if this user can alter shipment/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`warehouseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableWarehouseIds
Description	Gets a list of warehouses including and under the given warehouse node in which any shipment can be assigned.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.id.IdList`		list of assignable warehouse `Ids`
Errors	NULL_ARGUMENT		`warehouseId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableWarehouseIdsForShipment
Description	Gets a list of warehouses including and under the given warehouse node in which a specific shipment can be assigned.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment`
Return	`osid.id.IdList`		list of assignable warehouse `Ids`
Errors	NULL_ARGUMENT		`warehouseId` or `shipmentId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignShipmentToWarehouse
Description	Adds an existing `Shipment` to a `Warehouse`.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment`
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Errors	ALREADY_EXISTS		`shipmentId` is already assigned to `warehouseId`
	NOT_FOUND		`shipmentId` or `warehouseId` not found
	NULL_ARGUMENT		`shipmentId` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignShipmentFromWarehouse
Description	Removes a `Shipment` from a `Warehouse`.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment`
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Errors	NOT_FOUND		`shipmentId` or `warehouseId` not found or `shipmentId` not assigned to `warehouseId`
	NULL_ARGUMENT		`shipmentId` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignShipmentToWarehouse
Description	Moves a `Shipment` from one `Warehouse` to another. Mappings to other `Warehouses` are unaffected.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of the `Shipment`
	`osid.id.Id`	`fromWarehouseId`	the `Id` of the current `Warehouse`
	`osid.id.Id`	`toWarehouseId`	the `Id` of the destination `Warehouse`
Errors	ALREADY_EXISTS		`shipmentId` already assigned to `toWarehouseId`
	NOT_FOUND		`shipmentId, fromWarehouseId`, or `toWarehouseId` not found or `shipmentId` not mapped to `fromWarehouseId`
	NULL_ARGUMENT		`shipmentId, fromWarehouseId`, or `toWarehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.