chemistry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From f...@apache.org
Subject svn commit: r1331755 - in /chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api: CmisObject.java Document.java
Date Sat, 28 Apr 2012 12:21:10 GMT
Author: fmui
Date: Sat Apr 28 12:21:10 2012
New Revision: 1331755

URL: http://svn.apache.org/viewvc?rev=1331755&view=rev
Log:
CMIS-528: improved JavaDoc

Modified:
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObject.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObject.java
URL: http://svn.apache.org/viewvc/chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObject.java?rev=1331755&r1=1331754&r2=1331755&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObject.java
(original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObject.java
Sat Apr 28 12:21:10 2012
@@ -64,26 +64,28 @@ public interface CmisObject extends Obje
     void delete(boolean allVersions);
 
     /**
-     * Updates the properties that are provided.
+     * Updates the provided properties and refreshes this object afterwards. If
+     * the repository created a new object, for example a new version, this new
+     * object is returned. Otherwise the current object is returned.
      * 
      * @param properties
      *            the properties to update
      * 
-     * @return the updated object (a repository might have created a new object)
+     * @return the updated object
      */
     CmisObject updateProperties(Map<String, ?> properties);
 
     /**
-     * Updates the properties that are provided.
+     * Updates the provided properties. If the repository created a new object,
+     * for example a new version, the object id of the new object is returned.
+     * Otherwise the object id of the current object is returned.
      * 
      * @param properties
      *            the properties to update
      * @param refresh
      *            indicates if the object should be refresh after the update
      * 
-     * @return the object id of the updated object (a repository might have
-     *         created a new object)
-     * 
+     * @return the object id of the updated object
      */
     ObjectId updateProperties(Map<String, ?> properties, boolean refresh);
 
@@ -97,12 +99,12 @@ public interface CmisObject extends Obje
     // policy service
 
     /**
-     * Applies policies to this object.
+     * Applies the provided policies and refreshes this object afterwards.
      */
     void applyPolicy(ObjectId... policyIds);
 
     /**
-     * Remove policies from this object.
+     * Remove the provided policies and refreshes this object afterwards.
      */
     void removePolicy(ObjectId... policyIds);
 
@@ -114,19 +116,19 @@ public interface CmisObject extends Obje
     // ACL service
 
     /**
-     * Adds and removes ACEs to the object.
+     * Adds and removes ACEs to the object and refreshes this object afterwards.
      * 
      * @return the new ACL of this object
      */
     Acl applyAcl(List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation);
 
     /**
-     * Adds ACEs to the object.
+     * Adds ACEs to the objec tand refreshes this object afterwards.
      */
     Acl addAcl(List<Ace> addAces, AclPropagation aclPropagation);
 
     /**
-     * Removes ACEs to the object.
+     * Removes ACEs to the object and refreshes this object afterwards.
      */
     Acl removeAcl(List<Ace> removeAces, AclPropagation aclPropagation);
 

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java
URL: http://svn.apache.org/viewvc/chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java?rev=1331755&r1=1331754&r2=1331755&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java
(original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java
Sat Apr 28 12:21:10 2012
@@ -57,7 +57,11 @@ public interface Document extends Fileab
     ContentStream getContentStream(String streamId);
 
     /**
-     * Sets a new content stream for the document.
+     * Sets a new content stream for the document and refreshes this object
+     * afterwards. If the repository created a new version, this new document is
+     * returned. Otherwise the current document is returned.
+     * 
+     * @return the updated document
      */
     Document setContentStream(ContentStream contentStream, boolean overwrite);
 
@@ -67,7 +71,11 @@ public interface Document extends Fileab
     ObjectId setContentStream(ContentStream contentStream, boolean overwrite, boolean refresh);
 
     /**
-     * Removes the current content stream from the document.
+     * Removes the current content stream from the document and refreshes this
+     * object afterwards. If the repository created a new version, this new
+     * document is returned. Otherwise the current document is returned.
+     * 
+     * @return the updated document
      */
     Document deleteContentStream();
 
@@ -82,7 +90,7 @@ public interface Document extends Fileab
      * Checks out the document and returns the object id of the PWC (private
      * working copy).
      * 
-     * @return PWC id
+     * @return PWC object id
      */
     ObjectId checkOut(); // returns the PWC id
 



Mime
View raw message