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

This session defines methods for managing a hierarchy of Warehouse objects. Each node in the hierarchy is a unique Warehouse.

MethodgetWarehouseHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyWarehouseHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootWarehouse
Description

Adds a root warehouse.

Parametersosid.id.IdwarehouseIdthe Id of a warehouse
ErrorsALREADY_EXISTS warehouseId is already in hierarchy
NOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootWarehouse
Description

Removes a warehouse.

Parametersosid.id.IdwarehouseIdthe Id of a warehouse
ErrorsNOT_FOUND warehouseId not a root
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildWarehouse
Description

Adds a child to a warehouse.

Parametersosid.id.IdwarehouseIdthe Id of a warehouse
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS warehouseId is already a parent of childId
NOT_FOUND warehouseId or childId not found
NULL_ARGUMENT warehouseId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildWarehouse
Description

Removes a child from a warehouse.

Parametersosid.id.IdwarehouseIdthe Id of a warehouse
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND warehouseId is not a parent of childId
NULL_ARGUMENT warehouseId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildWarehouses
Description

Removes all children from a warehouse.

Parametersosid.id.IdwarehouseIdthe Id of a warehouse
ErrorsNOT_FOUND warehouseId is in hierarchy
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.