svn commit: r696644 - /incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java

[ie...@apache.org]

Author: ieb
Date: Thu Sep 18 05:12:18 2008
New Revision: 696644

URL: http://svn.apache.org/viewvc?rev=696644&view=rev
Log:
SHINDIG-612

Updated Javadoc to reflect how CollectionOptions presents the queries.

Modified:
    incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java

Modified: incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java?rev=696644&r1=696643&r2=696644&view=diff
==============================================================================
--- incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java (original)
+++ incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java Thu Sep 18 05:12:18 2008
@@ -49,8 +49,25 @@
   }
 
   /**
+   * <p>
    * This filter can be any field of the object being filtered or the special js filters,
-   * hasApp or topFriends.  
+   * hasApp or topFriends.
+   * Other special Filters are
+   * </p>
+   * <dl>
+   * <dt>all</dt>
+   * <dd>Retrieves all friends</dd>
+   * <dt>hasApp</dt>
+   * <dd>Retrieves all friends with any data for this application.</dd>
+   * <dt>'topFriends</dt>
+   * <dd>Retrieves only the user's top friends.</dd>
+   * <dt>isFriendsWith</dt>
+   * <dd>Will filter the people requested by checking if they are friends with
+   * the given <a href="opensocial.IdSpec.html">idSpec</a>. Expects a
+   *    filterOptions parameter to be passed with the following fields defined:
+   *  - idSpec The <a href="opensocial.IdSpec.html">idSpec</a> that each person
+   *        must be friends with.</dd>
+   * </dl>
    * @return The field to filter by
    */
   public String getFilter() {
@@ -69,6 +86,13 @@
     this.filterOperation = filterOperation;
   }
 
+  /**
+   * Where a field filter has been specified (ie a non special filter) then this is the value of the
+   * filter. The exception is the isFriendsWith filter where this contains the value of the id who
+   * the all the results need to be friends with.
+   *
+   * @return
+   */
   public String getFilterValue() {
     return filterValue;
   }
@@ -77,6 +101,10 @@
     this.filterValue = filterValue;
   }
 
+  /**
+   * When paginating, the index of the first item to fetch.
+   * @return
+   */
   public int getFirst() {
     return first;
   }
@@ -85,6 +113,13 @@
     this.first = first;
   }
 
+  
+  /**
+   * The maximum number of items to fetch; defaults to 20. If set to a larger
+   * number, a container may honor the request, or may limit the number to a
+   * container-specified limit of at least 20.
+   * @return
+   */
   public int getMax() {
     return max;
   }