org.nuxeo.ecm.platform.computedgroups
Interface GroupComputer

All Known Implementing Classes:

AbstractAttributeBasedGroupComputer, AbstractGroupComputer, CompanyGroupComputer

public interface GroupComputer

Interface that must be implemented by all contributed GroupComputers.

Author:

Thierry Delprat

Method Summary

java.util.List<java.lang.String>	getAllGroupIds() Return all group ids.
java.util.List<java.lang.String>	getGroupMembers(java.lang.String groupName) Returns the members for a give group.
java.util.List<java.lang.String>	getGroupsForUser(NuxeoPrincipalImpl nuxeoPrincipal) Returns the group names for a give User.
java.util.List<java.lang.String>	getParentsGroupNames(java.lang.String groupName) Return parent groups.
java.util.List<java.lang.String>	getSubGroupsNames(java.lang.String groupName) Returns children groups.
boolean	hasGroup(java.lang.String name) Returns true if the given group exists.
java.util.List<java.lang.String>	searchGroups(java.util.Map<java.lang.String,java.io.Serializable> filter, java.util.HashSet<java.lang.String> fulltext) Searches for a group.

Method Detail

getGroupsForUser

java.util.List<java.lang.String> getGroupsForUser(NuxeoPrincipalImpl nuxeoPrincipal)
                                                  throws java.lang.Exception

Returns the group names for a give User.

Throws:

java.lang.Exception

getAllGroupIds

java.util.List<java.lang.String> getAllGroupIds()
                                                throws java.lang.Exception

Return all group ids. If you class can not efficiently compute this list, you can return an empty list. In this case you need to implement the searchGroups method.

Throws:

java.lang.Exception

getGroupMembers

java.util.List<java.lang.String> getGroupMembers(java.lang.String groupName)
                                                 throws java.lang.Exception

Returns the members for a give group.

Throws:

java.lang.Exception

getParentsGroupNames

java.util.List<java.lang.String> getParentsGroupNames(java.lang.String groupName)
                                                      throws java.lang.Exception

Return parent groups.

Throws:

java.lang.Exception

getSubGroupsNames

java.util.List<java.lang.String> getSubGroupsNames(java.lang.String groupName)
                                                   throws java.lang.Exception

Returns children groups.

Throws:

java.lang.Exception

searchGroups

java.util.List<java.lang.String> searchGroups(java.util.Map<java.lang.String,java.io.Serializable> filter,
                                              java.util.HashSet<java.lang.String> fulltext)
                                              throws java.lang.Exception

Searches for a group. (This method is used in particular from UI to search/select a group).

Throws:

java.lang.Exception

hasGroup

boolean hasGroup(java.lang.String name)
                 throws java.lang.Exception

Returns true if the given group exists.

Throws:

java.lang.Exception