svn commit: r691072 - in /incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model: Address.java Person.java

[ie...@apache.org]

Author: ieb
Date: Mon Sep  1 14:56:24 2008
New Revision: 691072

URL: http://svn.apache.org/viewvc?rev=691072&view=rev
Log:
Updates to Javadoc in the light of implementing the SPI. Providing some clarification where the model is not clear from the javadoc.

Modified:
    incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java
    incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java

Modified: incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java?rev=691072&r1=691071&r2=691072&view=diff
==============================================================================
--- incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java (original)
+++ incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java Mon Sep  1 14:56:24 2008
@@ -206,11 +206,19 @@
   void setFormatted(String formatted);
 
   /**
+   * <p>
    * Get a Boolean value indicating whether this instance of the Plural Field is the primary or
    * preferred value of for this field, e.g. the preferred mailing address. Service Providers MUST
    * NOT mark more than one instance of the same Plural Field as primary="true", and MAY choose not
    * to mark any fields as primary, if this information is not available. Introduced in v0.8.1
-   *
+   * </p><p>
+   * The service provider may wish to share the address instance between items and primary related
+   * to the address from which this came, so if the address came from an Organization, primary
+   * relates to the primary address of the organization, and not necessary the primary address of
+   * all addresses.
+   * </p><p>
+   * If the address is not part of a list (eg Person.location ) primary has no meaning.
+   * <p>
    * @return true if the instance if the primary instance.
    */
   Boolean getPrimary();

Modified: incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java?rev=691072&r1=691071&r2=691072&view=diff
==============================================================================
--- incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java (original)
+++ incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Person.java Mon Sep  1 14:56:24 2008
@@ -512,7 +512,8 @@
 
   /**
    * Get if the person has used the current app. Container support for this field is OPTIONAL.
-   *
+   * Has app needs to take account of the context of the application that is performing the
+   * query on this person object.
    * @return true the current app has been used
    */
   Boolean getHasApp();