org.sakaiproject.hierarchy

Interface HierarchyProvider

All Superinterfaces:

HierarchyNodeReader

public interface HierarchyProvider
extends HierarchyNodeReader

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

Author:

Aaron Zeckoski (aaronz@vt.edu)

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIERARCHY_PERM_NODE_REMOVE
static String	HIERARCHY_PERM_NODE_UPDATE

Method Summary

Modifier and Type	Method and Description
boolean	checkUserNodePerm(String userId, String nodeId, String hierarchyPermConstant) 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

Methods inherited from interface org.sakaiproject.hierarchy.HierarchyNodeReader

getChildNodes, getNodeById, getNodesByIds, getParentNodes, getRootNode

Field Detail

HIERARCHY_PERM_NODE_UPDATE

static final String HIERARCHY_PERM_NODE_UPDATE

See Also:

Constant Field Values

HIERARCHY_PERM_NODE_REMOVE

static final String HIERARCHY_PERM_NODE_REMOVE

See Also:

Constant Field Values

Method Detail

checkUserNodePerm

boolean checkUserNodePerm(String userId,
                          String nodeId,
                          String hierarchyPermConstant)

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

Parameters:

userId - the internal user id (not username)

nodeId - a unique id for a hierarchy node

hierarchyPermConstant - a HIERARCHY_PERM_NODE constant

Returns:

true if the user has this permission, false otherwise