org.sakaiproject.hierarchy

Interface HierarchyService

All Superinterfaces:

HierarchyNodeReader, HierarchyNodeWriter, HierarchyPermissions, HierarchyTokens

public interface HierarchyService
extends HierarchyNodeReader, HierarchyNodeWriter, HierarchyTokens, HierarchyPermissions

This service interface defines the capabilities of the hierarchy system

Author:

Aaron Zeckoski (aaronz@vt.edu)

Method Summary

Modifier and Type	Method and Description
HierarchyNode	createHierarchy(String hierarchyId) Creates a new hierarchy with the unique id specified, exception if this id is already used
void	destroyHierarchy(String hierarchyId) Completely and permanantly destroy a hierarchy and all related nodes
HierarchyNode	setHierarchyRootNode(String hierarchyId, String nodeId) Sets the root node of this hierarchy, note that although a hierarchy might have multiple nodes at the top of the hierarchy, it always has a primary node which is considering the "entry point" into the hierarchy A node must have no parents to be set to the root node The first node added to a hierarchy becomes the root node by default

Methods inherited from interface org.sakaiproject.hierarchy.HierarchyNodeReader

getChildNodes, getNodeById, getNodesByIds, getParentNodes, getRootNode

Methods inherited from interface org.sakaiproject.hierarchy.HierarchyNodeWriter

addChildRelation, addNode, addParentRelation, removeChildRelation, removeNode, removeParentRelation, saveNodeMetaData, setNodeDisabled

Methods inherited from interface org.sakaiproject.hierarchy.HierarchyTokens

getNodesWithToken, getNodesWithTokens

Methods inherited from interface org.sakaiproject.hierarchy.HierarchyPermissions

assignUserNodePerm, checkUserNodePerm, getNodesAndPermsForUser, getNodesForUserPerm, getPermsForUserNodes, getUserIdsForNodesPerm, getUsersAndPermsForNodes, removeUserNodePerm

Method Detail

createHierarchy

HierarchyNode createHierarchy(String hierarchyId)

Creates a new hierarchy with the unique id specified, exception if this id is already used

Parameters:

hierarchyId - a unique id which defines the hierarchy

Returns:

the object representing the root node of the new hierarchy

setHierarchyRootNode

HierarchyNode setHierarchyRootNode(String hierarchyId,
                                   String nodeId)

Sets the root node of this hierarchy, note that although a hierarchy might have multiple nodes at the top of the hierarchy, it always has a primary node which is considering the "entry point" into the hierarchy
A node must have no parents to be set to the root node
The first node added to a hierarchy becomes the root node by default

Parameters:

hierarchyId - a unique id which defines the hierarchy

nodeId - a unique id for a hierarchy node

Returns:

the object representing the node which is now the root node

destroyHierarchy

void destroyHierarchy(String hierarchyId)

Completely and permanantly destroy a hierarchy and all related nodes

Parameters:

hierarchyId - a unique id which defines the hierarchy