Interface WarehouseHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface WarehouseHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Warehouses . 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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessWarehouseHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildWarehouseIds(Id warehouseId)	Gets the child Ids of the given warehouse.
WarehouseList	getChildWarehouses(Id warehouseId)	Gets the children of the given warehouse.
IdList	getParentWarehouseIds(Id warehouseId)	Gets the parent Ids of the given warehouse.
WarehouseList	getParentWarehouses(Id warehouseId)	Gets the parents of the given warehouse.
IdList	getRootWarehouseIds()	Gets the root warehouse Ids in this hierarchy.
WarehouseList	getRootWarehouses()	Gets the root warehouses in the warehouse hierarchy.
Hierarchy	getWarehouseHierarchy()	Gets the hierarchy associated with this session.
Id	getWarehouseHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getWarehouseNodeIds(Id warehouseId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given warehouse.
WarehouseNode	getWarehouseNodes(Id warehouseId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given warehouse.
boolean	hasChildWarehouses(Id warehouseId)	Tests if a warehouse has any children.
boolean	hasParentWarehouses(Id warehouseId)	Tests if the Warehouse has any parents.
boolean	isAncestorOfWarehouse(Id id, Id warehouseId)	Tests if an Id is an ancestor of a warehouse.
boolean	isChildOfWarehouse(Id id, Id warehouseId)	Tests if a warehouse is a direct child of another.
boolean	isDescendantOfWarehouse(Id id, Id warehouseId)	Tests if an Id is a descendant of a warehouse.
boolean	isParentOfWarehouse(Id id, Id warehouseId)	Tests if an Id is a direct parent of warehouse.
void	useComparativeWarehouseView()	The returns from the warehouse methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryWarehouseView()	A complete view of the Warehouses returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getWarehouseHierarchyId

Id getWarehouseHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getWarehouseHierarchy

Hierarchy getWarehouseHierarchy()
                         throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessWarehouseHierarchy

boolean canAccessWarehouseHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeWarehouseView

void useComparativeWarehouseView()

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.

usePlenaryWarehouseView

void usePlenaryWarehouseView()

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.

Compliance:

mandatory - This method is must be implemented.

getRootWarehouseIds

IdList getRootWarehouseIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root warehouse Ids in this hierarchy.

Returns:

the root catalog Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootWarehouses

WarehouseList getRootWarehouses()
                         throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root warehouses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentWarehouses

boolean hasParentWarehouses(Id warehouseId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Warehouse has any parents.

Parameters:

warehouseId - a catalog Id

Returns:

true if the catalog has parents, f alse otherwise

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfWarehouse

boolean isParentOfWarehouse(Id id,
 Id warehouseId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of warehouse.

Parameters:

id - an Id

warehouseId - the Id of a catalog

Returns:

true if this id is a parent of warehouseId , f alse otherwise

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - id or warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentWarehouseIds

IdList getParentWarehouseIds(Id warehouseId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given warehouse.

Parameters:

warehouseId - a catalog Id

Returns:

the parent Ids of the catalog

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentWarehouses

WarehouseList getParentWarehouses(Id warehouseId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given warehouse.

Parameters:

warehouseId - the Id to query

Returns:

the parents of the warehouse

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfWarehouse

boolean isAncestorOfWarehouse(Id id,
 Id warehouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a warehouse.

Parameters:

id - an Id

warehouseId - the Id of a catalog

Returns:

true if this id is an ancestor of warehouseId , false otherwise

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildWarehouses

boolean hasChildWarehouses(Id warehouseId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a warehouse has any children.

Parameters:

warehouseId - a warehouse Id

Returns:

true if the warehouseId has children, false otherwise

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfWarehouse

boolean isChildOfWarehouse(Id id,
 Id warehouseId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a warehouse is a direct child of another.

Parameters:

id - an Id

warehouseId - the Id of a catalog

Returns:

true if the id is a child of warehouseId , false otherwise

Throws:

NotFoundException - warehouseId not found

NullArgumentException - id or warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildWarehouseIds

IdList getChildWarehouseIds(Id warehouseId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given warehouse.

Parameters:

warehouseId - the Id to query

Returns:

the children of the catalog

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildWarehouses

WarehouseList getChildWarehouses(Id warehouseId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given warehouse.

Parameters:

warehouseId - the Id to query

Returns:

the children of the warehouse

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfWarehouse

boolean isDescendantOfWarehouse(Id id,
 Id warehouseId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a warehouse.

Parameters:

id - an Id

warehouseId - the Id of a catalog

Returns:

true if the id is a descendant of the warehouseId , false otherwise

Throws:

NotFoundException - warehouseId not found

NullArgumentException - id or warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getWarehouseNodeIds

Node getWarehouseNodeIds(Id warehouseId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given warehouse.

Parameters:

warehouseId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a catalog node

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseNodes

WarehouseNode getWarehouseNodes(Id warehouseId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given warehouse.

Parameters:

warehouseId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a catalog node

Throws:

NotFoundException - warehouseId not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.