Interface | osid.inventory.WarehouseHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
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 This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getWarehouseHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAccessWarehouseHierarchy | ||
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 | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeWarehouseView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryWarehouseView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootWarehouseIds | ||
Description |
Gets the root warehouse | ||
Return | osid.id.IdList | the root catalog Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootWarehouses | ||
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. | ||
Return | osid.inventory.WarehouseList | the root warehouses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentWarehouses | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | warehouseId | a catalog Id |
Return | boolean | true if the catalog has parents, f alse
otherwise | |
Errors | NOT_FOUND | warehouseId is not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfWarehouse | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | warehouseId | the Id of a catalog | |
Return | boolean | true if this id is a parent of
warehouseId, f alse otherwise | |
Errors | NOT_FOUND | warehouseId is not found | |
NULL_ARGUMENT | id or warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentWarehouseIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | warehouseId | a catalog Id |
Return | osid.id.IdList | the parent Ids of the catalog | |
Errors | NOT_FOUND | warehouseId is not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentWarehouses | ||
Description |
Gets the parents of the given warehouse. | ||
Parameters | osid.id.Id | warehouseId | the Id to query |
Return | osid.inventory.WarehouseList | the parents of the warehouse | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfWarehouse | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | warehouseId | the Id of a catalog | |
Return | boolean | tru e if this id is an ancestor of
warehouseId, false otherwise | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildWarehouses | ||
Description |
Tests if a warehouse has any children. | ||
Parameters | osid.id.Id | warehouseId | a warehouse Id |
Return | boolean | true if the warehouseId has children,
false otherwise | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfWarehouse | ||
Description |
Tests if a warehouse is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | warehouseId | the Id of a catalog | |
Return | boolean | true if the id is a child of
warehouseId, false otherwise | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | id or warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildWarehouseIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | warehouseId | the Id to query |
Return | osid.id.IdList | the children of the catalog | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildWarehouses | ||
Description |
Gets the children of the given warehouse. | ||
Parameters | osid.id.Id | warehouseId | the Id to query |
Return | osid.inventory.WarehouseList | the children of the warehouse | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfWarehouse | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | warehouseId | the Id of a catalog | |
Return | boolean | true if the id is a descendant of the
warehouseId, false otherwise | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | id or warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getWarehouseNodeIds | ||
Description |
Gets a portion of the hierarchy for the given warehouse. | ||
Parameters | osid.id.Id | warehouseId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a catalog node | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseNodes | ||
Description |
Gets a portion of the hierarchy for the given warehouse. | ||
Parameters | osid.id.Id | warehouseId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.inventory.WarehouseNode | a catalog node | |
Errors | NOT_FOUND | warehouseId not found | |
NULL_ARGUMENT | warehouseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |