|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XWikiGroupService
Interface giving access to users and groups management.
Method Summary | |
---|---|
void |
addUserToGroup(String user,
String database,
String group,
XWikiContext context)
Adding the user to the group cache. |
int |
countAllGroupsNamesForMember(String member,
XWikiContext context)
Return the number of groups containing provided member. |
int |
countAllMatchedGroups(Object[][] matchFields,
XWikiContext context)
Return number of groups with provided constraints. |
int |
countAllMatchedUsers(Object[][] matchFields,
XWikiContext context)
Return number of users with provided constraints. |
int |
countAllMembersNamesForGroup(String group,
XWikiContext context)
Return the number of members provided group contains. |
void |
flushCache()
|
Collection<String> |
getAllGroupsNamesForMember(String member,
int nb,
int start,
XWikiContext context)
Get all groups containing provided member in the provided member wiki. |
Collection<DocumentReference> |
getAllGroupsReferencesForMember(DocumentReference memberReference,
int limit,
int offset,
XWikiContext context)
Get all groups containing provided member in the current wiki. |
List<?> |
getAllMatchedGroups(Object[][] matchFields,
boolean withdetails,
int nb,
int start,
Object[][] order,
XWikiContext context)
Search for all groups with provided constraints and in a provided order. |
Collection<String> |
getAllMatchedMembersNamesForGroup(String group,
String matchField,
int nb,
int start,
Boolean orderAsc,
XWikiContext context)
Get members of provided group. |
List<?> |
getAllMatchedUsers(Object[][] matchFields,
boolean withdetails,
int nb,
int start,
Object[][] order,
XWikiContext context)
Search for all users with provided constraints and in a provided order. |
Collection<String> |
getAllMembersNamesForGroup(String group,
int nb,
int start,
XWikiContext context)
Get all members provided group contains. |
void |
init(XWiki xwiki,
XWikiContext context)
|
void |
initCache(int iCapacity,
XWikiContext context)
|
void |
initCache(XWikiContext context)
|
List<String> |
listAllGroups(XWikiContext context)
Deprecated. Use getAllMatchedGroups(Object[][], boolean, int, int, Object[][], XWikiContext) . |
Collection<String> |
listGroupsForUser(String username,
XWikiContext context)
Deprecated. Use getAllGroupsNamesForMember(String, int, int, XWikiContext) . |
List<String> |
listMemberForGroup(String s,
XWikiContext context)
Deprecated. Use getAllMembersNamesForGroup(String, int, int, XWikiContext) . |
void |
removeUserOrGroupFromAllGroups(String userOrGroupWiki,
String userOrGroupSpace,
String userOrGroupName,
XWikiContext context)
Remove user or group name from all groups. |
Method Detail |
---|
void init(XWiki xwiki, XWikiContext context) throws XWikiException
XWikiException
void initCache(XWikiContext context) throws XWikiException
XWikiException
void initCache(int iCapacity, XWikiContext context) throws XWikiException
XWikiException
void flushCache()
@Deprecated Collection<String> listGroupsForUser(String username, XWikiContext context) throws XWikiException
getAllGroupsNamesForMember(String, int, int, XWikiContext)
.
XWikiException
void addUserToGroup(String user, String database, String group, XWikiContext context) throws XWikiException
XWikiException
void removeUserOrGroupFromAllGroups(String userOrGroupWiki, String userOrGroupSpace, String userOrGroupName, XWikiContext context) throws XWikiException
userOrGroupWiki
- the name of the wiki of the member.userOrGroupSpace
- the name of the space of the member.userOrGroupName
- the name of the member.context
- the XWiki context.
XWikiException
- error when browsing groups.@Deprecated List<String> listMemberForGroup(String s, XWikiContext context) throws XWikiException
getAllMembersNamesForGroup(String, int, int, XWikiContext)
.
XWikiException
@Deprecated List<String> listAllGroups(XWikiContext context) throws XWikiException
getAllMatchedGroups(Object[][], boolean, int, int, Object[][], XWikiContext)
.
XWikiException
List<?> getAllMatchedUsers(Object[][] matchFields, boolean withdetails, int nb, int start, Object[][] order, XWikiContext context) throws XWikiException
matchFields
- the field to math with values. It is a table of table with :
withdetails
- indicate if a List
containing String
names is returned or List
containing XWikiDocument
.nb
- the maximum number of results to return. Infinite if 0.start
- the index of the first found user to return.order
- the fields to order from. It is a table of table with :
context
- the XWikiContext
.
XWikiException
- error when getting users.List<?> getAllMatchedGroups(Object[][] matchFields, boolean withdetails, int nb, int start, Object[][] order, XWikiContext context) throws XWikiException
matchFields
- the field to math with values. It is a table of table with :
withdetails
- indicate if a List
containing String
names is returned or List
containing XWikiDocument
.nb
- the maximum number of result to return. Infinite if 0.start
- the index of the first found group to return.order
- the field to order from. It is a table of table with :
context
- the XWikiContext
.
XWikiException
- error when getting groups.int countAllMatchedUsers(Object[][] matchFields, XWikiContext context) throws XWikiException
matchFields
- the field to math with values. It is a table of table with :
context
- the XWikiContext
.
XWikiException
- error when getting number of users.int countAllMatchedGroups(Object[][] matchFields, XWikiContext context) throws XWikiException
matchFields
- the field to math with values. It is a table of table with :
context
- the XWikiContext
.
XWikiException
- error when getting number of groups.Collection<String> getAllGroupsNamesForMember(String member, int nb, int start, XWikiContext context) throws XWikiException
member
- the name of the member (user or group).nb
- the maximum number of result to return.start
- the index of the first found member to return.context
- the XWiki context.
Collection
of String
containing group name.
XWikiException
- error when browsing groups.Collection<DocumentReference> getAllGroupsReferencesForMember(DocumentReference memberReference, int limit, int offset, XWikiContext context) throws XWikiException
memberReference
- the member. Can be either user or group.limit
- the maximum number of result to return.offset
- the index of the first found member to return.context
- the XWiki context.
Collection
of DocumentReference
containing representing groups.
XWikiException
- error when browsing groups.Collection<String> getAllMembersNamesForGroup(String group, int nb, int start, XWikiContext context) throws XWikiException
group
- the name of the group.nb
- the maximum number of result to return.start
- the index of the first found user to return.context
- the XWiki context.
Collection
of String
containing member name.
XWikiException
- error when browsing groups.Collection<String> getAllMatchedMembersNamesForGroup(String group, String matchField, int nb, int start, Boolean orderAsc, XWikiContext context) throws XWikiException
group
- the group.matchField
- a string to search in result to filter.nb
- the maximum number of result to return.start
- the index of the first found user to return.orderAsc
- if true, the result is ordered ascendent, if false it descendant. If null no order is applied.context
- the XWiki context.
Collection
of String
containing member name.
XWikiException
- error when browsing groups.int countAllGroupsNamesForMember(String member, XWikiContext context) throws XWikiException
member
- the name of the member (user or group).context
- the XWiki context.
XWikiException
- error when getting number of users.int countAllMembersNamesForGroup(String group, XWikiContext context) throws XWikiException
group
- the name of the group.context
- the XWiki context.
XWikiException
- error when getting number of groups.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |