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

This session defines methods for traversing a hierarchy of Warehouse objects. Each node in the hierarchy is a unique Warehouse. The hierarchy may be traversed recursively to establish the tree structure through getParentWarehouses() and getChildWarehouses(). To relate these Ids to another OSID, getWarehouseNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Warehouse available in the Inventory OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentWarehouses() or getChildWarehouse() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: warehouse elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
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.
MethodcanAccessWarehouseHierarchy
Description

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeWarehouseView
Description

The returns from the warehouse methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryWarehouseView
Description

A complete view of the Warehouses 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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootWarehouseIds
Description

Gets the root warehouse Ids in this hierarchy.

Returnosid.id.IdListthe root catalog Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootWarehouses
Description

Gets the root warehouses in the warehouse hierarchy. A node with no parents is an orphan. While all warehouse Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.inventory.WarehouseListthe root warehouses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentWarehouses
Description

Tests if the Warehouse has any parents.

Parametersosid.id.IdwarehouseIda catalog Id
Returnboolean true if the catalog has parents, f alse otherwise
ErrorsNOT_FOUND warehouseId is not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfWarehouse
Description

Tests if an Id is a direct parent of warehouse.

Parametersosid.id.Ididan Id
osid.id.IdwarehouseIdthe Id of a catalog
Returnboolean true if this id is a parent of warehouseId, f alse otherwise
ErrorsNOT_FOUND warehouseId is not found
NULL_ARGUMENT id or warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentWarehouseIds
Description

Gets the parent Ids of the given warehouse.

Parametersosid.id.IdwarehouseIda catalog Id
Returnosid.id.IdListthe parent Ids of the catalog
ErrorsNOT_FOUND warehouseId is not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentWarehouses
Description

Gets the parents of the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id to query
Returnosid.inventory.WarehouseListthe parents of the warehouse
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfWarehouse
Description

Tests if an Id is an ancestor of a warehouse.

Parametersosid.id.Ididan Id
osid.id.IdwarehouseIdthe Id of a catalog
Returnboolean tru e if this id is an ancestor of warehouseId, false otherwise
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildWarehouses
Description

Tests if a warehouse has any children.

Parametersosid.id.IdwarehouseIda warehouse Id
Returnboolean true if the warehouseId has children, false otherwise
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfWarehouse
Description

Tests if a warehouse is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdwarehouseIdthe Id of a catalog
Returnboolean true if the id is a child of warehouseId, false otherwise
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT id or warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildWarehouseIds
Description

Gets the child Ids of the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id to query
Returnosid.id.IdListthe children of the catalog
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildWarehouses
Description

Gets the children of the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id to query
Returnosid.inventory.WarehouseListthe children of the warehouse
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfWarehouse
Description

Tests if an Id is a descendant of a warehouse.

Parametersosid.id.Ididan Id
osid.id.IdwarehouseIdthe Id of a catalog
Returnboolean true if the id is a descendant of the warehouseId, false otherwise
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT id or warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetWarehouseNodeIds
Description

Gets a portion of the hierarchy for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea catalog node
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseNodes
Description

Gets a portion of the hierarchy for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.inventory.WarehouseNodea catalog node
ErrorsNOT_FOUND warehouseId not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.