Author: tmortagne
Date: 2007-10-26 17:12:46 +0200 (Fri, 26 Oct 2007)
New Revision: 5523
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/Document.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/objects/classes/BaseClass.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManageRightsApi.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManager.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerException.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPlugin.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPluginApi.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/AllowDeny.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/LevelTree.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/RequestLimit.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/UsersGroups.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiStoreInterface.java
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java
Log:
Add some "@since XWiki Core 1.1.2, XWiki Core 1.2M2" in new methods and classes.
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/Document.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/Document.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/Document.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -123,6 +123,7 @@
/**
* @return the name of the wiki where this document is stored.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public String getWiki()
{
@@ -155,6 +156,7 @@
/**
* @return the real full name of a document containing wiki name where
document is stored.
* For document in "xwiki" wiki, with name "MyDoc" and space "MySpace" the
extended full name is "xwiki:MySpace.MyDoc".
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public String getPrefixedFullName()
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/objects/classes/BaseClass.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/objects/classes/BaseClass.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/objects/classes/BaseClass.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -353,6 +353,9 @@
return addUsersField(fieldName, fieldPrettyName, true);
}
+ /**
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
public boolean addUsersField(String fieldName, String fieldPrettyName,
boolean multiSelect)
{
return addUsersField(fieldName, fieldPrettyName, 5, multiSelect);
@@ -363,6 +366,9 @@
return addUsersField(fieldName, fieldPrettyName, size, true);
}
+ /**
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
public boolean addUsersField(String fieldName, String fieldPrettyName, int
size,
boolean multiSelect)
{
@@ -444,6 +450,9 @@
return addStaticListField(fieldName, fieldPrettyName, size,
multiSelect, values, displayType, null);
}
+ /**
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
public boolean addStaticListField(String fieldName, String
fieldPrettyName, int size, boolean multiSelect, String values, String
displayType, String separators) {
if (get(fieldName)==null) {
StaticListClass list_class = new StaticListClass();
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManageRightsApi.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManageRightsApi.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManageRightsApi.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -33,6 +33,7 @@
* API for managing rights and inheritance.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class RightsManageRightsApi extends Api
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManager.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManager.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManager.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -48,6 +48,7 @@
* Hidden toolkit use by the plugin API that make all the plugins actions.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
final class RightsManager implements XWikiDocChangeNotificationInterface
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerException.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerException.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerException.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -26,6 +26,7 @@
* Rights Manager plugin base exception.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class RightsManagerException extends PluginException
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPlugin.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPlugin.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPlugin.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -32,6 +32,7 @@
* Entry point of the Rights Manager plugin.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class RightsManagerPlugin extends XWikiDefaultPlugin
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPluginApi.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPluginApi.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/RightsManagerPluginApi.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -40,6 +40,7 @@
* API for managing rights, users and groups.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class RightsManagerPluginApi extends PluginApi
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/AllowDeny.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/AllowDeny.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/AllowDeny.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -4,6 +4,7 @@
* Contains list of users and groups for allow right and deny right.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class AllowDeny
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/LevelTree.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/LevelTree.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/LevelTree.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -4,6 +4,7 @@
* Contains all rights for a level right.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class LevelTree
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/RequestLimit.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/RequestLimit.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/RequestLimit.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -4,6 +4,7 @@
* Contains maximum number of result to return and index of the first element.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class RequestLimit
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/UsersGroups.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/UsersGroups.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/plugin/rightsmanager/utils/UsersGroups.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -7,6 +7,7 @@
* Contains a collection of users and groups.
*
* @version $Id: $
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public class UsersGroups
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -277,6 +277,7 @@
* @param wikiName the wiki name to convert.
* @param context the XWiki context.
* @return the database/schema name.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
protected String getSchemaFromWikiName(String wikiName, XWikiContext
context)
{
@@ -303,6 +304,7 @@
*
* @param context the XWiki context.
* @return the database/schema name.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
protected String getSchemaFromWikiName(XWikiContext context)
{
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiStoreInterface.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiStoreInterface.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiStoreInterface.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -153,6 +153,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List searchDocuments(String wheresql, boolean distinctbylanguage,
int nb, int start,
List parameterValues, XWikiContext context) throws XWikiException;
@@ -224,6 +225,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List searchDocuments(String wheresql, List parameterValues,
XWikiContext context)
throws XWikiException;
@@ -249,6 +251,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List searchDocuments(String wheresql, boolean distinctbylanguage,
boolean customMapping, int nb, int start, List parameterValues,
XWikiContext context)
@@ -272,6 +275,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List searchDocuments(String wheresql, int nb, int start, List
parameterValues,
XWikiContext context) throws XWikiException;
@@ -299,6 +303,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List searchDocuments(String wheresql, boolean distinctbylanguage,
boolean customMapping, boolean checkRight, int nb, int start, List
parameterValues,
@@ -343,6 +348,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List search(String sql, int nb, int start, List parameterValues,
XWikiContext context) throws XWikiException;
@@ -380,6 +386,7 @@
* context.
* @return a list of XWikiDocument.
* @throws XWikiException in case of error while performing the query.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
*/
public List search(String sql, int nb, int start, Object[][] whereParams,
List parameterValues, XWikiContext context) throws XWikiException;
Modified:
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java
2007-10-26 15:11:30 UTC (rev 5522)
+++
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/user/api/XWikiGroupService.java
2007-10-26 15:12:46 UTC (rev 5523)
@@ -33,208 +33,170 @@
*
* @version $Id: $
*/
-public interface XWikiGroupService {
- public void init(XWiki xwiki, XWikiContext context) throws
XWikiException;
+public interface XWikiGroupService
+{
+ public void init(XWiki xwiki, XWikiContext context) throws XWikiException;
- public void initCache(XWikiContext context) throws XWikiException;
+ public void initCache(XWikiContext context) throws XWikiException;
- public void initCache(int iCapacity, XWikiContext context)
- throws XWikiException;
+ public void initCache(int iCapacity, XWikiContext context) throws
XWikiException;
- public void flushCache();
+ public void flushCache();
- /**
- * @deprecated Use
- * [EMAIL PROTECTED] #getAllGroupsNamesForMember(String,
int, int, XWikiContext)}.
- */
- public Collection listGroupsForUser(String username, XWikiContext
context)
- throws XWikiException;
+ /**
+ * @deprecated Use [EMAIL PROTECTED] #getAllGroupsNamesForMember(String,
int, int, XWikiContext)}.
+ */
+ public Collection listGroupsForUser(String username, XWikiContext context)
+ throws XWikiException;
- public void addUserToGroup(String user, String database, String group,
- XWikiContext context) throws XWikiException;
+ public void addUserToGroup(String user, String database, String group,
XWikiContext context)
+ throws XWikiException;
- /**
- * Remove user or group name from all groups.
- *
- * @param userOrGroupWiki
- * the name of the wiki of the member.
- * @param userOrGroupSpace
- * the name of the space of the member.
- * @param userOrGroupName
- * the name of the member.
- * @param context
- * the XWiki context.
- * @throws XWikiException
- * error when browsing groups.
- */
- public void removeUserOrGroupFromAllGroups(String userOrGroupWiki,
- String userOrGroupSpace, String userOrGroupName,
- XWikiContext context) throws XWikiException;
+ /**
+ * Remove user or group name from all groups.
+ *
+ * @param userOrGroupWiki the name of the wiki of the member.
+ * @param userOrGroupSpace the name of the space of the member.
+ * @param userOrGroupName the name of the member.
+ * @param context the XWiki context.
+ * @throws XWikiException error when browsing groups.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ public void removeUserOrGroupFromAllGroups(String userOrGroupWiki, String
userOrGroupSpace,
+ String userOrGroupName, XWikiContext context) throws XWikiException;
- /**
+ /**
* @deprecated Use [EMAIL PROTECTED] #getAllMembersNamesForGroup(String,
int, int, XWikiContext)}.
*/
- public List listMemberForGroup(String s, XWikiContext context)
- throws XWikiException;
+ public List listMemberForGroup(String s, XWikiContext context) throws
XWikiException;
- /**
- * @deprecated Use [EMAIL PROTECTED] #getAllMatchedGroups(Object[][],
boolean, int, int, Object[][], XWikiContext)}.
+ /**
+ * @deprecated Use
+ * [EMAIL PROTECTED] #getAllMatchedGroups(Object[][], boolean,
int, int, Object[][], XWikiContext)}.
*/
- public List listAllGroups(XWikiContext context) throws XWikiException;
+ public List listAllGroups(XWikiContext context) throws XWikiException;
- /**
- * Search for all users with provided constraints and in a provided
order.
- *
- * @param matchFields
- * the field to math with values. It is a table of table
with :
- * <ul>
- * <li>fiedname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * <li>pattern matching : based on HQL "like" command</li>
- * </ul>
- * @param withdetails
- * indicate if a [EMAIL PROTECTED] List} containing [EMAIL
PROTECTED] String} names is
- * returned or [EMAIL PROTECTED] List} containing
- * [EMAIL PROTECTED] com.xpn.xwiki.doc.XWikiDocument}.
- * @param nb
- * the maximum number od result to return.
- * @param start
- * the index of the first found user to return.
- * @param order
- * the fields to order from. It is a table of table with :
- * <ul>
- * <li>fieldname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * </ul>
- * @param context
- * the [EMAIL PROTECTED] XWikiContext}.
- * @return the list of users.
- * @throws XWikiException
- * error when getting users.
- */
- List getAllMatchedUsers(Object[][] matchFields, boolean withdetails,
- int nb, int start, Object[][] order, XWikiContext
context)
- throws XWikiException;
+ /**
+ * Search for all users with provided constraints and in a provided order.
+ *
+ * @param matchFields the field to math with values. It is a table of
table with :
+ * <ul>
+ * <li>fiedname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * <li>pattern matching : based on HQL "like" command</li>
+ * </ul>
+ * @param withdetails indicate if a [EMAIL PROTECTED] List} containing
[EMAIL PROTECTED] String} names is returned or
+ * [EMAIL PROTECTED] List} containing [EMAIL PROTECTED]
com.xpn.xwiki.doc.XWikiDocument}.
+ * @param nb the maximum number od result to return.
+ * @param start the index of the first found user to return.
+ * @param order the fields to order from. It is a table of table with :
+ * <ul>
+ * <li>fieldname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * </ul>
+ * @param context the [EMAIL PROTECTED] XWikiContext}.
+ * @return the list of users.
+ * @throws XWikiException error when getting users.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ List getAllMatchedUsers(Object[][] matchFields, boolean withdetails, int
nb, int start,
+ Object[][] order, XWikiContext context) throws XWikiException;
- /**
- * Search for all groups with provided constraints and in a provided
order.
- *
- * @param matchFields
- * the field to math with values. It is a table of table
with :
- * <ul>
- * <li>fiedname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * <li>pattern matching : based on HQL "like" command</li>
- * </ul>.
- * @param withdetails
- * indicate if a [EMAIL PROTECTED] List} containing [EMAIL
PROTECTED] String} names is
- * returned or [EMAIL PROTECTED] List} containing
- * [EMAIL PROTECTED] com.xpn.xwiki.doc.XWikiDocument}.
- * @param nb
- * the maximum number od result to return.
- * @param start
- * the index of the first found group to return.
- * @param order
- * the field to order from. It is a table of table with :
- * <ul>
- * <li>fieldname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * </ul>
- * @param context
- * the [EMAIL PROTECTED] XWikiContext}.
- * @return the list of groups.
- * @throws XWikiException
- * error when getting groups.
- */
- List getAllMatchedGroups(Object[][] matchFields, boolean withdetails,
- int nb, int start, Object[][] order, XWikiContext
context)
- throws XWikiException;
+ /**
+ * Search for all groups with provided constraints and in a provided order.
+ *
+ * @param matchFields the field to math with values. It is a table of
table with :
+ * <ul>
+ * <li>fiedname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * <li>pattern matching : based on HQL "like" command</li>
+ * </ul>.
+ * @param withdetails indicate if a [EMAIL PROTECTED] List} containing
[EMAIL PROTECTED] String} names is returned or
+ * [EMAIL PROTECTED] List} containing [EMAIL PROTECTED]
com.xpn.xwiki.doc.XWikiDocument}.
+ * @param nb the maximum number od result to return.
+ * @param start the index of the first found group to return.
+ * @param order the field to order from. It is a table of table with :
+ * <ul>
+ * <li>fieldname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * </ul>
+ * @param context the [EMAIL PROTECTED] XWikiContext}.
+ * @return the list of groups.
+ * @throws XWikiException error when getting groups.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ List getAllMatchedGroups(Object[][] matchFields, boolean withdetails, int
nb, int start,
+ Object[][] order, XWikiContext context) throws XWikiException;
- /**
- * Return number of users with provided constraints.
- *
- * @param matchFields
- * the field to math with values. It is a table of table
with :
- * <ul>
- * <li>fiedname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * <li>pattern matching : based on HQL "like" command</li>
- * </ul>.
- * @param nb
- * the maximum number of result to return.
- * @param start
- * the index of the first found user to return.
- * @param context
- * the [EMAIL PROTECTED] XWikiContext}.
- * @return the of found users.
- * @throws XWikiException
- * error when getting number of users.
- */
- int countAllMatchedUsers(Object[][] matchFields, int nb, int start,
- XWikiContext context) throws XWikiException;
+ /**
+ * Return number of users with provided constraints.
+ *
+ * @param matchFields the field to math with values. It is a table of
table with :
+ * <ul>
+ * <li>fiedname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * <li>pattern matching : based on HQL "like" command</li>
+ * </ul>.
+ * @param nb the maximum number of result to return.
+ * @param start the index of the first found user to return.
+ * @param context the [EMAIL PROTECTED] XWikiContext}.
+ * @return the of found users.
+ * @throws XWikiException error when getting number of users.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ int countAllMatchedUsers(Object[][] matchFields, int nb, int start,
XWikiContext context)
+ throws XWikiException;
- /**
- * Return number of groups with provided constraints.
- *
- * @param matchFields
- * the field to math with values. It is a table of table
with :
- * <ul>
- * <li>fiedname : the name of the field</li>
- * <li>fieldtype : for example StringProperty. If null the
field
- * is considered as document field</li>
- * <li>pattern matching : based on HQL "like" command</li>
- * </ul>.
- * @param nb
- * the maximum number of result to return.
- * @param start
- * the index of the first found user to return.
- * @param context
- * the [EMAIL PROTECTED] XWikiContext}.
- * @return the of found groups.
- * @throws XWikiException
- * error when getting number of groups.
- */
- int countAllMatchedGroups(Object[][] matchFields, int nb, int start,
- XWikiContext context) throws XWikiException;
+ /**
+ * Return number of groups with provided constraints.
+ *
+ * @param matchFields the field to math with values. It is a table of
table with :
+ * <ul>
+ * <li>fiedname : the name of the field</li>
+ * <li>fieldtype : for example StringProperty. If null the
field is considered as
+ * document field</li>
+ * <li>pattern matching : based on HQL "like" command</li>
+ * </ul>.
+ * @param nb the maximum number of result to return.
+ * @param start the index of the first found user to return.
+ * @param context the [EMAIL PROTECTED] XWikiContext}.
+ * @return the of found groups.
+ * @throws XWikiException error when getting number of groups.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ int countAllMatchedGroups(Object[][] matchFields, int nb, int start,
XWikiContext context)
+ throws XWikiException;
- /**
- * Get all groups containing provided user.
- *
- * @param member
- * the name of the member (user or group).
- * @param nb
- * the maximum number of result to return.
- * @param start
- * the index of the first found member to return.
- * @param context
- * the XWiki context.
- * @return the [EMAIL PROTECTED] Collection} of [EMAIL PROTECTED]
String} containing group name.
- * @throws XWikiException
- * error when browsing groups.
- */
- public Collection getAllGroupsNamesForMember(String member, int nb,
- int start, XWikiContext context) throws XWikiException;
+ /**
+ * Get all groups containing provided user.
+ *
+ * @param member the name of the member (user or group).
+ * @param nb the maximum number of result to return.
+ * @param start the index of the first found member to return.
+ * @param context the XWiki context.
+ * @return the [EMAIL PROTECTED] Collection} of [EMAIL PROTECTED] String}
containing group name.
+ * @throws XWikiException error when browsing groups.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ public Collection getAllGroupsNamesForMember(String member, int nb, int
start,
+ XWikiContext context) throws XWikiException;
- /**
- * Get all users provided group contains.
- *
- * @param group
- * the name of the group.
- * @param nb
- * the maximum number of result to return.
- * @param start
- * the index of the first found user to return.
- * @param context
- * the XWiki context.
- * @return the [EMAIL PROTECTED] Collection} of [EMAIL PROTECTED]
String} containing user name.
- * @throws XWikiException
- * error when browsing groups.
- */
- public Collection getAllMembersNamesForGroup(String group, int nb,
- int start, XWikiContext context) throws XWikiException;
+ /**
+ * Get all users provided group contains.
+ *
+ * @param group the name of the group.
+ * @param nb the maximum number of result to return.
+ * @param start the index of the first found user to return.
+ * @param context the XWiki context.
+ * @return the [EMAIL PROTECTED] Collection} of [EMAIL PROTECTED] String}
containing user name.
+ * @throws XWikiException error when browsing groups.
+ * @since XWiki Core 1.1.2, XWiki Core 1.2M2
+ */
+ public Collection getAllMembersNamesForGroup(String group, int nb, int
start,
+ XWikiContext context) throws XWikiException;
}
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
