Interface GroupComputer
- All Known Subinterfaces:
GroupComputerLabelled
- All Known Implementing Classes:
AbstractAttributeBasedGroupComputer
,AbstractGroupComputer
,CompanyGroupComputer
,DocumentMetadataGroupComputer
,MultiTenantGroupComputer
,ShibbolethGroupComputer
,UserMetadataGroupComputer
public interface GroupComputer
Interface that must be implemented by all contributed
GroupComputer
s.- Author:
- Thierry Delprat
-
Method Summary
Modifier and TypeMethodDescriptionReturn all group ids.getGroupMembers
(String groupName) Returns the members for a give group.getGroupsForUser
(NuxeoPrincipalImpl nuxeoPrincipal) Returns the group names for a give User.getParentsGroupNames
(String groupName) Return parent groups.getSubGroupsNames
(String groupName) Returns children groups.boolean
Returns true if the given group exists.searchGroups
(Map<String, Serializable> filter, Set<String> fulltext) Searches for a group.searchGroups
(QueryBuilder queryBuilder) Searches for groups.
-
Method Details
-
getGroupsForUser
Returns the group names for a give User. -
getAllGroupIds
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. -
getGroupMembers
Returns the members for a give group. -
getParentsGroupNames
Return parent groups. -
getSubGroupsNames
Returns children groups. -
searchGroups
Searches for a group. (This method is used in particular from UI to search/select a group). -
searchGroups
Searches for groups.- Parameters:
queryBuilder
- the query- Returns:
- the list of computed group ids
- Since:
- 10.3
-
hasGroup
Returns true if the given group exists.
-