org.sakaiproject.hierarchy

Interface HierarchyTokens

All Known Subinterfaces:

HierarchyService

public interface HierarchyTokens

This adds in the ability to define permissions key token searching

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Method Summary

Modifier and Type	Method and Description
Set<String>	getNodesWithToken(String hierarchyId, String permToken) Find all nodes for a hierarchy associated with a token key
Map<String,Set<String>>	getNodesWithTokens(String hierarchyId, String[] permTokens) Find all the nodes for a hierarchy associated with a set of token keys

Method Detail

getNodesWithToken

Set<String> getNodesWithToken(String hierarchyId,
                              String permToken)

Find all nodes for a hierarchy associated with a token key

Parameters:

hierarchyId - a unique id which defines the hierarchy

permToken - a permissions token key

Returns:

a set of nodeIds, empty if no nodes found

getNodesWithTokens

Map<String,Set<String>> getNodesWithTokens(String hierarchyId,
                                           String[] permTokens)

Find all the nodes for a hierarchy associated with a set of token keys

Parameters:

hierarchyId - a unique id which defines the hierarchy

permTokens - an array of permissions token keys

Returns:

a map of tokenKey -> set of nodeIds, empty if no nodes found