@Role
public interface GroupManager
Modifier and Type | Method and Description |
---|---|
Collection<DocumentReference> |
getGroups(DocumentReference member,
Object wikiTarget,
boolean recurse)
Search groups the passed user or group is member of.
|
Collection<DocumentReference> |
getMembers(DocumentReference group,
boolean recurse)
Retrieve the users and groups which are the members of the passed group.
|
Collection<DocumentReference> getGroups(DocumentReference member, Object wikiTarget, boolean recurse) throws GroupException
{code wikis} controls where to search for the groups and recurse
only the direct group should be
returned or the whole hierarchy.
member
- the group member (user or group)wikiTarget
- the wikis where to search. The following types are supported:
WikiTarget
String
Collection<String>
org.xwiki.model.reference.WikiReference
Collection<org.xwiki.model.reference.WikiReference>
recurse
- false if only the direct groups should be returned, true to take into account groups of groupsGroupException
- when failing to get groupsCollection<DocumentReference> getMembers(DocumentReference group, boolean recurse) throws GroupException
group
- the group for which to return the membersrecurse
- false if only the direct members should be returned, true to take into account groups of groupsGroupException
- when failing to get membersCopyright © 2004–2021 XWiki. All rights reserved.