OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.StockWarehouseAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Stocks to Warehouse objects A Stock may appear in multiple Warehouse objects and removing the last reference to a Stock 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 Stock to another Warehouse is not a copy operation (eg: does not change its Id ).

MethodcanAssignStocks
Description

Tests if this user can alter stock/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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignStockToWarehouse
Description

Tests if this user can alter stock/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.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT warehouseId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableWarehouseIds
Description

Gets a list of warehouses including and under the given warehouse node in which any stock can be assigned.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
Returnosid.id.IdListlist of assignable warehouse Ids
ErrorsNULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableWarehouseIdsForStock
Description

Gets a list of warehouses including and under the given warehouse node in which a specific stock can be assigned.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.id.IdstockIdthe Id of the Stock
Returnosid.id.IdListlist of assignable warehouse Ids
ErrorsNULL_ARGUMENT warehouseId or stockId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStockToWarehouse
Description

Adds an existing Stock to a Warehouse.

Parametersosid.id.IdstockIdthe Id of the Stock
osid.id.IdwarehouseIdthe Id of the Warehouse
ErrorsALREADY_EXISTS stockId is already assigned to warehouseId
NOT_FOUND stockId or warehouseId not found
NULL_ARGUMENT stockId or warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStockFromWarehouse
Description

Removes a Stock from a Warehouse.

Parametersosid.id.IdstockIdthe Id of the Stock
osid.id.IdwarehouseIdthe Id of the Warehouse
ErrorsNOT_FOUND stockId or warehouseId not found or stockId not assigned to warehouseId
NULL_ARGUMENT stockId or warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.