[Openutils-svn] SF.net SVN: openutils:[2431] trunk/openutils-mgnlcriteria/src/main/java/net /sourceforge/openutils/mgnlcriteria/jcr/query/Criteria.java

[<die...@us...>]

Revision: 2431
          http://openutils.svn.sourceforge.net/openutils/?rev=2431&view=rev
Author:   diego_schivo
Date:     2010-05-12 17:17:07 +0000 (Wed, 12 May 2010)

Log Message:
-----------
CRIT-11 javadocs

Modified Paths:
--------------
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/Criteria.java

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/Criteria.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/Criteria.java	2010-05-12 16:51:27 UTC (rev 2430)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/Criteria.java	2010-05-12 17:17:07 UTC (rev 2431)
@@ -156,31 +156,31 @@
     Collection< ? > list() throws JCRQueryException;
 
     /**
-     * 
-     * @param path
-     * @return
+     * Sets the base path of the query, i.e. the branch in the repository tree where the search will take place
+     * @param path the handle of a node, or a xpath query prefix in the form //handle/of/a/node//*
+     * @return this (for method chaining)
      */
     Criteria setBasePath(String path);
 
     /**
      * 
-     * @param itemsPerPage
-     * @param pageNumberStartingFromOne
-     * @return
+     * @param itemsPerPage maximum number of results per page (i.e. page size)
+     * @param pageNumberStartingFromOne page number to retrieve (1, 2, 3, ...)
+     * @return this (for method chaining)
      */
     Criteria setPaging(int itemsPerPage, int pageNumberStartingFromOne);
 
     /**
      * 
      * @param spellCheckString
-     * @return
+     * @return this (for method chaining)
      */
     Criteria setSpellCheckString(String spellCheckString);
 
     /**
-     * 
-     * @param path
-     * @return
+     * Sets the name of the workspace where the search will take place
+     * @param workspace the name of a workspace
+     * @return this (for method chaining)
      */
     Criteria setWorkspace(String workspace);
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.