Skip navigation links
A C D E G H I O P R S T 

A

addChildRelation(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Add children to a node (creates the association), only adds direct children (directly connected to this node), others are implicitly defined,
this will not create loops in the hierarchy
addNode(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Add a new node to a hierarchy
addParentRelation(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Add parents to a node (creates the association), only adds direct parents (directly connected to this node), others are implicitly defined,
this will not create loops in the hierarchy
assignUserNodePerm(String, String, String, boolean) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Assign the given permission to a user for the given hierarchy node, can cascade the permission downward if desired

C

checkUserNodePerm(String, String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Determine if a user has a specific hierarchy permission at a specific hierarchy node, a permission key can be any string though it will most likely be from a relatively small set
checkUserNodePerm(String, String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyProvider
Determine if a user has a specific hierarchy permission at a specific hierarchy node
The actual permissions this should handle are shown at the top of this class
childNodeIds - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
a set of all children for this node
createHierarchy(String) - Method in interface org.sakaiproject.hierarchy.HierarchyService
Creates a new hierarchy with the unique id specified, exception if this id is already used

D

description - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
the description for this node
destroyHierarchy(String) - Method in interface org.sakaiproject.hierarchy.HierarchyService
Completely and permanantly destroy a hierarchy and all related nodes
directChildNodeIds - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
a set of all direct children for this node, the ids of child nodes that touch this node directly
directParentNodeIds - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
a set of all direct parents for this node, the ids of parent nodes that touch this node directly

E

equals(Object) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
equals(Object) - Method in class org.sakaiproject.hierarchy.model.HierarchyNode
 

G

getChildIds() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
getChildNodes(String, boolean) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeReader
Get all children nodes for this node in the hierarchy all the way to the leaves, will return no nodes if this node has no children
getCreatedOn() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getDescription() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getDirectChildIds() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
getDirectParentIds() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
getHierarchyId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
Getters and Setters
getIsDisabled() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getIsRootNode() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getLastModified() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getNode() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getNodeById(String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeReader
Get a node based on the unique id, convenience method for HierarchyNodeReader.getNodesByIds(String[])
getNodeId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getNodesAndPermsForUser(String...) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Get all the nodeIds and permissions for the given userIds, the returned map will always contain every userId that was passed in as a key
getNodesByIds(String[]) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeReader
Get a set of nodes based on their unique ids, NOTE: this method is here for efficiency
getNodesForUserPerm(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Get the hierarchy nodes which a user has a specific permission in, this is used to find a set of nodes which a user should be able to see and to build the list of hierarchy nodes a user has a given permission in
getNodesWithToken(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyTokens
Find all nodes for a hierarchy associated with a token key
getNodesWithTokens(String, String[]) - Method in interface org.sakaiproject.hierarchy.HierarchyTokens
Find all the nodes for a hierarchy associated with a set of token keys
getOwnerId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getParentIds() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
getParentNodes(String, boolean) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeReader
Get all the parent nodes for a specific node all the way to the root node, returns empty set if this is the root node
getPermission() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getPermsForUserNodes(String, String[]) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Get the set of all permissions which a user has on a node or group of nodes, NOTE: this will get the set of ALL permissions inclusively for the given nodeIds so nodes in the set which a user has no permissions on will not cause this to return no permissions, example: for given user: nodeA(perm1, perm2), nodeB(perm1), nodeC(perm2), nodeD() : returns: (perm1, perm2)
getPermToken() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getRootNode(String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeReader
Get the hierarchy root node for a specific hierarchy if it exists
getSortedNodes(Collection<HierarchyNode>) - Static method in class org.sakaiproject.hierarchy.utils.HierarchyUtils
Create a sorted list of nodes based on a set of input nodes, list goes from root (or highest parent) down to the bottom most node
getTitle() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
getUniqueChildNodes(Collection<HierarchyNode>, boolean, boolean) - Static method in class org.sakaiproject.hierarchy.utils.HierarchyUtils
Create a set of all the unique child node ids based on the set of supplied nodes, can optionally be limited to return only direct children and to include the supplied node ids
getUniqueParentNodes(Collection<HierarchyNode>, boolean, boolean) - Static method in class org.sakaiproject.hierarchy.utils.HierarchyUtils
Create a set of all the unique parent node ids based on the set of supplied nodes, can optionally be limited to return only direct parents and to include the supplied node ids
getUserId() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
getUserIdsForNodesPerm(String[], String) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Get all the userIds for users which have a specific permission in a set of hierarchy nodes, this can be used to check one node or many nodes as needed
getUsersAndPermsForNodes(String...) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Get all the users and permissions currently assigned to nodes, the returned map will always contain every passed in nodeId as a key
This is not super efficient by itself so it should not used when other methods are sufficient, however, it is actually much better than calling the other methods repeatedly so this is primarily for use in administrative interfaces

H

hashCode() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
hashCode() - Method in class org.sakaiproject.hierarchy.model.HierarchyNode
 
HIERARCHY_PERM_NODE_REMOVE - Static variable in interface org.sakaiproject.hierarchy.HierarchyProvider
 
HIERARCHY_PERM_NODE_UPDATE - Static variable in interface org.sakaiproject.hierarchy.HierarchyProvider
 
hierarchyId - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
The assigned unique id for the hierarchy this node is in
HierarchyNode - Class in org.sakaiproject.hierarchy.model
This pea represents a node in a hierarchy (in academics a department or college would probably be represented by a node)
HierarchyNode() - Constructor for class org.sakaiproject.hierarchy.model.HierarchyNode
Empty constructor
HierarchyNode(String, String, String, String, Set<String>, Set<String>, Set<String>, Set<String>, Boolean) - Constructor for class org.sakaiproject.hierarchy.model.HierarchyNode
Testing constructor
HierarchyNodeMetaData - Class in org.sakaiproject.hierarchy.dao.model
This is the persistent object for storing Hierarchy Node meta data
HierarchyNodeMetaData() - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
Empty constructor
HierarchyNodeMetaData(HierarchyPersistentNode, String, Boolean, String) - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
minimal
HierarchyNodeMetaData(HierarchyPersistentNode, String, Boolean, String, String, String, String, Boolean) - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
full
HierarchyNodePermission - Class in org.sakaiproject.hierarchy.dao.model
This represents a single authorization entry in the hierarchy system, this is DROP dead simplistic and needs to probably be improved VASTLY
HierarchyNodePermission() - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
HierarchyNodePermission(String, String, String) - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
HierarchyNodeReader - Interface in org.sakaiproject.hierarchy
Allows user to get hierarchical node data from the hierarchy
HierarchyNodeWriter - Interface in org.sakaiproject.hierarchy
Allows user to control nodes (create, update, remove)
HierarchyPermissions - Interface in org.sakaiproject.hierarchy
This interface contains the methods for assigning and checking permissions in the hierarchy
HierarchyPersistentNode - Class in org.sakaiproject.hierarchy.dao.model
This is the persistent object for storing Hierarchy Nodes
HierarchyPersistentNode() - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
Empty constructor
HierarchyPersistentNode(String, String) - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
Leaf constructor
HierarchyPersistentNode(String, String, String, String) - Constructor for class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
Full constructor
HierarchyProvider - Interface in org.sakaiproject.hierarchy
This interface provides methods to get hierarchical node data into sakai for use in determining the structure above sites/groups related to adminstration and access to data and control of permissions
HierarchyService - Interface in org.sakaiproject.hierarchy
This service interface defines the capabilities of the hierarchy system
HierarchyTokens - Interface in org.sakaiproject.hierarchy
This adds in the ability to define permissions key token searching
HierarchyUtils - Class in org.sakaiproject.hierarchy.utils
Simple utils to assist with working with the hierarchy
HierarchyUtils() - Constructor for class org.sakaiproject.hierarchy.utils.HierarchyUtils
 

I

id - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
The unique id for this hierarchy node
isDisabled - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
boolean representing whether or not node is disabled

O

org.sakaiproject.hierarchy - package org.sakaiproject.hierarchy
 
org.sakaiproject.hierarchy.dao.model - package org.sakaiproject.hierarchy.dao.model
 
org.sakaiproject.hierarchy.model - package org.sakaiproject.hierarchy.model
 
org.sakaiproject.hierarchy.utils - package org.sakaiproject.hierarchy.utils
 

P

parentNodeIds - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
a set of all parents for this node
permToken - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
the permissions token for the associated node, can be looked up in the permissions token key generator service

R

removeChildRelation(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Remove a child relation from a node, this will not be allowed to orphan a node
removeNode(String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Remove a node from the hierarchy if it is possible, nodes can only be removed if they have no children associations, root nodes can never be removed, exception occurs if these rules are violated
removeParentRelation(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Remove a parent relation from a node, this will not be allowed to orphan a node, only extra parents may be removed, the last parent for a node cannot currently be removed
removeUserNodePerm(String, String, String, boolean) - Method in interface org.sakaiproject.hierarchy.HierarchyPermissions
Remove a permission for a user from the given hierarchy node, can cascade the permission downward if desired

S

saveNodeMetaData(String, String, String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Save meta data on a node, this is optional and nodes do not need meta data associated, if the params are nulls then the values remain unchanged, if they are empty string then the values are wiped out
setChildIds(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
setCreatedOn(Date) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
setDescription(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setDirectChildIds(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
setDirectParentIds(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
setHierarchyId(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setHierarchyRootNode(String, String) - Method in interface org.sakaiproject.hierarchy.HierarchyService
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
setId(Long) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setId(Long) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
setId(Long) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
setIsDisabled(Boolean) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setIsRootNode(Boolean) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setLastModified(Date) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
setNode(HierarchyPersistentNode) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setNodeDisabled(String, Boolean) - Method in interface org.sakaiproject.hierarchy.HierarchyNodeWriter
Enables/disables the node.
setNodeId(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
setOwnerId(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setParentIds(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyPersistentNode
 
setPermission(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
setPermToken(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setTitle(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodeMetaData
 
setUserId(String) - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 

T

title - Variable in class org.sakaiproject.hierarchy.model.HierarchyNode
the title of this node
toString() - Method in class org.sakaiproject.hierarchy.dao.model.HierarchyNodePermission
 
toString() - Method in class org.sakaiproject.hierarchy.model.HierarchyNode
 
A C D E G H I O P R S T 
Skip navigation links

Copyright © 2003–2021 Sakai Project. All rights reserved.