Interface DepotHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DepotHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Depots . Each node in the hierarchy is a unique Depot . The hierarchy may be traversed recursively to establish the tree structure through getParentDepots() and getChildDepots() . To relate these Ids to another OSID, getDepotNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Depot available in the Depoting 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 getParentDepots() or getChildDepots() 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: depot 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	canAccessDepotHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildDepotIds(Id depotId)	Gets the child Ids of the given depot.
DepotList	getChildDepots(Id depotId)	Gets the children of the given depot.
Hierarchy	getDepotHierarchy()	Gets the hierarchy associated with this session.
Id	getDepotHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getDepotNodeIds(Id depotId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given depot.
DepotNode	getDepotNodes(Id depotId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given depot.
IdList	getParentDepotIds(Id depotId)	Gets the parent Ids of the given depot.
DepotList	getParentDepots(Id depotId)	Gets the parents of the given depot.
IdList	getRootDepotIds()	Gets the root depot Ids in this hierarchy.
DepotList	getRootDepots()	Gets the root depots in this depot hierarchy.
boolean	hasChildDepots(Id depotId)	Tests if a depot has any children.
boolean	hasParentDepots(Id depotId)	Tests if the Depot has any parents.
boolean	isAncestorOfDepot(Id id, Id depotId)	Tests if an Id is an ancestor of a depot.
boolean	isChildOfDepot(Id id, Id depotId)	Tests if a depot is a direct child of another.
boolean	isDescendantOfDepot(Id id, Id depotId)	Tests if an Id is a descendant of a depot.
boolean	isParentOfDepot(Id id, Id depotId)	Tests if an Id is a direct parent of a depot.
void	useComparativeDepotView()	The returns from the depot methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryDepotView()	A complete view of the Hierarchy 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

getDepotHierarchyId

Id getDepotHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDepotHierarchy

Hierarchy getDepotHierarchy()
                     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.

canAccessDepotHierarchy

boolean canAccessDepotHierarchy()

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 an application that may not offer hierrachy traversal operations to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDepotView

void useComparativeDepotView()

The returns from the depot 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.

usePlenaryDepotView

void usePlenaryDepotView()

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

getRootDepotIds

IdList getRootDepotIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root depot Ids in this hierarchy.

Returns:

the root depot Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootDepots

DepotList getRootDepots()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root depots in this depot hierarchy.

Returns:

the root depots

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentDepots

boolean hasParentDepots(Id depotId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Depot has any parents.

Parameters:

depotId - the Id of a depot

Returns:

true if the depot has parents, false otherwise

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfDepot

boolean isParentOfDepot(Id id,
 Id depotId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a depot.

Parameters:

id - an Id

depotId - the Id of a depot

Returns:

true if this id is a parent of depotId , false otherwise

Throws:

NotFoundException - depotId is not found

NullArgumentException - id or depotId 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} .

getParentDepotIds

IdList getParentDepotIds(Id depotId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given depot.

Parameters:

depotId - the Id of a depot

Returns:

the parent Ids of the depot

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentDepots

DepotList getParentDepots(Id depotId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given depot.

Parameters:

depotId - the Id of a depot

Returns:

the parents of the depot

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfDepot

boolean isAncestorOfDepot(Id id,
 Id depotId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a depot.

Parameters:

id - an Id

depotId - the Id of a depot

Returns:

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

Throws:

NotFoundException - depotId is not found

NullArgumentException - id or depotId 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} .

hasChildDepots

boolean hasChildDepots(Id depotId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a depot has any children.

Parameters:

depotId - the Id of a depot

Returns:

true if the depotId has children, false otherwise

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfDepot

boolean isChildOfDepot(Id id,
 Id depotId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a depot is a direct child of another.

Parameters:

id - an Id

depotId - the Id of a depot

Returns:

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

Throws:

NotFoundException - depotId is not found

NullArgumentException - id or depotId 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} .

getChildDepotIds

IdList getChildDepotIds(Id depotId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given depot.

Parameters:

depotId - the Id to query

Returns:

the children of the depot

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildDepots

DepotList getChildDepots(Id depotId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given depot.

Parameters:

depotId - the Id to query

Returns:

the children of the depot

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfDepot

boolean isDescendantOfDepot(Id id,
 Id depotId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a depot.

Parameters:

id - an Id

depotId - the Id of a depot

Returns:

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

Throws:

NotFoundException - depotId is not found

NullArgumentException - id or depotId 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} .

getDepotNodeIds

Node getDepotNodeIds(Id depotId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given depot.

Parameters:

depotId - 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 depot node

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepotNodes

DepotNode getDepotNodes(Id depotId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given depot.

Parameters:

depotId - 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 depot node

Throws:

NotFoundException - depotId is not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.