|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.rightsmanager.RightsManagerGroupsApi
public class RightsManagerGroupsApi
API for managing groups.
Field Summary | |
---|---|
static String |
CONTEXT_LASTERRORCODE
Field name of the last error code inserted in context. |
static String |
CONTEXT_LASTEXCEPTION
Field name of the last api exception inserted in context. |
protected static org.slf4j.Logger |
LOGGER
The logging toolkit. |
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
RightsManagerGroupsApi(XWikiContext context)
Create an instance of RightsManageRightsApi. |
Method Summary | |
---|---|
int |
countAllGlobalGroups()
|
int |
countAllGroups()
|
int |
countAllLocalGroups()
|
int |
countAllMatchedGlobalGroups(Map<?,?> matchFields)
|
int |
countAllMatchedGroups(Map<?,?> matchFields)
|
int |
countAllMatchedLocalGroups(Map<?,?> matchFields)
|
int |
countAllMatchedWikiGroups(String wikiName,
Map<?,?> matchFields)
Get the number of groups in the provided wiki. |
int |
countAllWikiGroups(String wikiName)
Get the number of groups in the provided wiki. |
List<Document> |
getAllGlobalGroups()
Get all groups in the main wiki. |
List<Document> |
getAllGlobalGroups(int nb,
int start)
Get all groups in the main wiki. |
List<String> |
getAllGlobalGroupsNames()
Get all groups names in the main wiki. |
List<String> |
getAllGlobalGroupsNames(int nb,
int start)
Get all groups names in the main wiki. |
List<Document> |
getAllGroups()
Get all groups in the main wiki and the current wiki. |
List<Document> |
getAllGroups(int nb,
int start)
Get all groups in the main wiki and the current wiki. |
List<String> |
getAllGroupsNames()
Get all groups names in the main wiki and the current wiki. |
List<String> |
getAllGroupsNames(int nb,
int start)
Get all groups names in the main wiki and the current wiki. |
List<Document> |
getAllLocalGroups()
Get all groups in the current wiki. |
List<Document> |
getAllLocalGroups(int nb,
int start)
Get all groups in the current wiki. |
List<String> |
getAllLocalGroupsNames()
Get all groups names in the current wiki. |
List<String> |
getAllLocalGroupsNames(int nb,
int start)
Get all groups names in the current wiki. |
List<Document> |
getAllMatchedGlobalGroups(Map<?,?> matchFields)
Get all groups in the main wiki. |
List<Document> |
getAllMatchedGlobalGroups(Map<?,?> matchFields,
int nb,
int start)
Get all groups in the main wiki. |
List<Document> |
getAllMatchedGlobalGroups(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups in the main wiki. |
List<String> |
getAllMatchedGlobalGroupsNames(Map<?,?> matchFields)
Get all groups names in the main wiki. |
List<String> |
getAllMatchedGlobalGroupsNames(Map<?,?> matchFields,
int nb,
int start)
Get all groups names in the main wiki. |
List<String> |
getAllMatchedGlobalGroupsNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups names in the main wiki. |
List<Document> |
getAllMatchedGroups(Map<?,?> matchFields)
Get all groups in the main wiki and the current wiki. |
List<Document> |
getAllMatchedGroups(Map<?,?> matchFields,
int nb,
int start)
Get all groups in the main wiki and the current wiki. |
List<Document> |
getAllMatchedGroups(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups in the main wiki and the current wiki. |
List<String> |
getAllMatchedGroupsNames(Map<?,?> matchFields)
Get all groups names in the main wiki and the current wiki. |
List<String> |
getAllMatchedGroupsNames(Map<?,?> matchFields,
int nb,
int start)
Get all groups names in the main wiki and the current wiki. |
List<String> |
getAllMatchedGroupsNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups names in the main wiki and the current wiki. |
List<Document> |
getAllMatchedLocalGroups(Map<?,?> matchFields)
Get all groups in the current wiki. |
List<Document> |
getAllMatchedLocalGroups(Map<?,?> matchFields,
int nb,
int start)
Get all groups in the current wiki. |
List<Document> |
getAllMatchedLocalGroups(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups in the current wiki. |
List<String> |
getAllMatchedLocalGroupsNames(Map<?,?> matchFields)
Get all groups names in the current wiki. |
List<String> |
getAllMatchedLocalGroupsNames(Map<?,?> matchFields,
int nb,
int start)
Get all groups names in the current wiki. |
List<String> |
getAllMatchedLocalGroupsNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups names in the current wiki. |
List<Document> |
getAllMatchedWikiGroups(String wikiName,
Map<?,?> matchFields)
Get all groups in the provided wiki. |
List<Document> |
getAllMatchedWikiGroups(String wikiName,
Map<?,?> matchFields,
int nb,
int start)
Get all groups in the provided wiki. |
List<Document> |
getAllMatchedWikiGroups(String wikiName,
Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups in the provided wiki. |
List<String> |
getAllMatchedWikiGroupsNames(String wikiName,
Map<?,?> matchFields)
Get all groups names in the provided wiki. |
List<String> |
getAllMatchedWikiGroupsNames(String wikiName,
Map<?,?> matchFields,
int nb,
int start)
Get all groups names in the provided wiki. |
List<String> |
getAllMatchedWikiGroupsNames(String wikiName,
Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all groups names in the provided wiki. |
List<Document> |
getAllWikiGroups(String wikiName)
Get all groups in the provided wiki. |
List<Document> |
getAllWikiGroups(String wikiName,
int nb,
int start)
Get all groups in the provided wiki. |
List<String> |
getAllWikiGroupsNames(String wikiName)
Get all groups names in the provided wiki. |
List<String> |
getAllWikiGroupsNames(String wikiName,
int nb,
int start)
Get all groups names in the provided wiki. |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
convert, convert, convert, convertAttachments, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONTEXT_LASTERRORCODE
public static final String CONTEXT_LASTEXCEPTION
protected static final org.slf4j.Logger LOGGER
Constructor Detail |
---|
public RightsManagerGroupsApi(XWikiContext context)
context
- the XWiki context.Method Detail |
---|
public int countAllGroups() throws XWikiException
XWikiException
- error when getting number of groups.public int countAllMatchedGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of groups.public int countAllWikiGroups(String wikiName) throws XWikiException
wikiName
- the name of the wiki where to search for groups.
XWikiException
- error when getting number of groups.public int countAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the name of the wiki where to search for groups.matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of groups.public int countAllGlobalGroups() throws XWikiException
XWikiException
- error when getting number of groups.public int countAllMatchedGlobalGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of groups.public int countAllLocalGroups() throws XWikiException
XWikiException
- error when getting number of groups.public int countAllMatchedLocalGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of groups.public List<String> getAllGroupsNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllGroupsNames() throws XWikiException
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGroupsNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGroupsNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGroupsNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllGlobalGroupsNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllGlobalGroupsNames() throws XWikiException
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGlobalGroupsNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGlobalGroupsNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedGlobalGroupsNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllWikiGroupsNames(String wikiName, int nb, int start) throws XWikiException
wikiName
- the name of the wiki where to search.nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllWikiGroupsNames(String wikiName) throws XWikiException
wikiName
- the name of the wiki where to search.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedWikiGroupsNames(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedWikiGroupsNames(String wikiName, Map<?,?> matchFields, int nb, int start) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedWikiGroupsNames(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllLocalGroupsNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllLocalGroupsNames() throws XWikiException
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedLocalGroupsNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedLocalGroupsNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<String> getAllMatchedLocalGroupsNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of String
containing group names.
XWikiException
- error when searching for groups.public List<Document> getAllGroups(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllGroups() throws XWikiException
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGroups(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGroups(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllGlobalGroups(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllGlobalGroups() throws XWikiException
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGlobalGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGlobalGroups(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedGlobalGroups(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllWikiGroups(String wikiName, int nb, int start) throws XWikiException
wikiName
- the name of the wiki where to search.nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllWikiGroups(String wikiName) throws XWikiException
wikiName
- the name of the wiki where to search.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields, int nb, int start) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
wikiName
- the name of the wiki where to search.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllLocalGroups(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllLocalGroups() throws XWikiException
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedLocalGroups(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedLocalGroups(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.
List
of Document
containing group.
XWikiException
- error when searching for groups.public List<Document> getAllMatchedLocalGroups(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found group to return.order
- the fields to order from. It is a List containing :
List
of Document
containing group.
XWikiException
- error when searching for groups.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |