Interface GraphHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GraphHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Graph objects. Each node in the hierarchy is a unique Graph . The hierarchy may be traversed recursively to establish the tree structure through getParentGraphs() and getChildGraphs() . To relate these Ids to another OSID, getGraphNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Graph available in the Topology 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 getParentGraphs() or getChildGraphs() 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 graph view: graph elements may be silently omitted or re-ordered
• plenary graph view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessGraphHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildGraphIds(Id graphId)	Gets the child Ids of the given graph.
GraphList	getChildGraphs(Id graphId)	Gets the children of the given graph.
Hierarchy	getGraphHierarchy()	Gets the hierarchy associated with this session.
Id	getGraphHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getGraphNodeIds(Id graphId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given graph.
GraphNode	getGraphNodes(Id graphId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given graph.
IdList	getParentGraphIds(Id graphId)	Gets the parent Ids of the given graph.
GraphList	getParentGraphs(Id graphId)	Gets the parents of the given graph.
IdList	getRootGraphIds()	Gets the root graph Ids in this hierarchy.
GraphList	getRootGraphs()	Gets the root graph in the graph hierarchy.
boolean	hasChildGraphs(Id graphId)	Tests if a graph has any children.
boolean	hasParentGraphs(Id graphId)	Tests if the Graph has any parents.
boolean	isAncestorOfGraph(Id id, Id graphId)	Tests if an Id is an ancestor of a graph.
boolean	isChildOfGraph(Id id, Id graphId)	Tests if a graph is a direct child of another.
boolean	isDescendantOfGraph(Id id, Id graphId)	Tests if an Id is a descendant of a graph.
boolean	isParentOfGraph(Id id, Id graphId)	Tests if an Id is a direct parent of graph.
void	useComparativeGraphView()	The returns from the graph methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryGraphView()	A complete view of the Graphs 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

getGraphHierarchyId

Id getGraphHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraphHierarchy

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

canAccessGraphHierarchy

boolean canAccessGraphHierarchy()

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.

useComparativeGraphView

void useComparativeGraphView()

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

usePlenaryGraphView

void usePlenaryGraphView()

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

getRootGraphIds

IdList getRootGraphIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root graph 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.

getRootGraphs

GraphList getRootGraphs()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root graph in the graph hierarchy. A node with no parents is an orphan. While all graph 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 graphs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentGraphs

boolean hasParentGraphs(Id graphId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Graph has any parents.

Parameters:

graphId - a catalog Id

Returns:

true if the catalog has parents, f alse otherwise

Throws:

NotFoundException - graphId is not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfGraph

boolean isParentOfGraph(Id id,
 Id graphId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of graph.

Parameters:

id - an Id

graphId - the Id of a graph

Returns:

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

Throws:

NotFoundException - graphId is not found

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

getParentGraphIds

IdList getParentGraphIds(Id graphId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given graph.

Parameters:

graphId - a catalog Id

Returns:

the parent Ids of the graph

Throws:

NotFoundException - graphId is not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentGraphs

GraphList getParentGraphs(Id graphId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given graph.

Parameters:

graphId - the Id to query

Returns:

the parents of the graph

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfGraph

boolean isAncestorOfGraph(Id id,
 Id graphId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a graph.

Parameters:

id - an Id

graphId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId 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} .

hasChildGraphs

boolean hasChildGraphs(Id graphId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a graph has any children.

Parameters:

graphId - a graph Id

Returns:

true if the graphId has children, false otherwise

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfGraph

boolean isChildOfGraph(Id id,
 Id graphId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a graph is a direct child of another.

Parameters:

id - an Id

graphId - the Id of a graph

Returns:

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

Throws:

NotFoundException - graphId not found

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

getChildGraphIds

IdList getChildGraphIds(Id graphId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given graph.

Parameters:

graphId - the Id to query

Returns:

the children of the catalog

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildGraphs

GraphList getChildGraphs(Id graphId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given graph.

Parameters:

graphId - the Id to query

Returns:

the children of the graph

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfGraph

boolean isDescendantOfGraph(Id id,
 Id graphId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a graph.

Parameters:

id - an Id

graphId - the Id of a catalog

Returns:

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

Throws:

NotFoundException - graphId not found

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

getGraphNodeIds

Node getGraphNodeIds(Id graphId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given graph.

Parameters:

graphId - 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 - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphNodes

GraphNode getGraphNodes(Id graphId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given graph.

Parameters:

graphId - 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 graph node

Throws:

NotFoundException - graphId not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.