chemistry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From f...@apache.org
Subject svn commit: r1537341 [1/2] - in /chemistry/opencmis/trunk: chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/ chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chem...
Date Wed, 30 Oct 2013 23:24:34 GMT
Author: fmui
Date: Wed Oct 30 23:24:33 2013
New Revision: 1537341

URL: http://svn.apache.org/r1537341
Log:
more JavaDoc and a few adjustments

Modified:
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvent.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvents.java
    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/CmisObjectProperties.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Document.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/DocumentProperties.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FileableCmisObject.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Folder.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FolderProperties.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectId.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectType.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/OperationContext.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/PolicyProperties.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Property.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryResult.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryStatement.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Relationship.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/RelationshipProperties.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/RelationshipType.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Rendition.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Repository.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Session.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/SessionFactory.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/runtime/ChangeEventsImpl.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/runtime/QueryResultImpl.java
    chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/runtime/RenditionImpl.java
    chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/ChangeEventInfo.java
    chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/MutableContentStream.java
    chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-impl/src/main/java/org/apache/chemistry/opencmis/commons/impl/XMLConstraints.java
    chemistry/opencmis/trunk/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/webservices/ObjectService.java
    chemistry/opencmis/trunk/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/webservices/ObjectService10.java
    chemistry/opencmis/trunk/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/webservices/VersioningService.java

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.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/SessionFactoryFinder.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java Wed Oct 30 23:24:33 2013
@@ -27,12 +27,25 @@ import java.lang.reflect.Method;
 import org.apache.chemistry.opencmis.client.api.SessionFactory;
 
 /**
- * Finds a {@link SessionFactory} implementation and creates an object.
+ * Finds a {@link SessionFactory} implementation and creates a factory object.
  */
-public class SessionFactoryFinder {
+public final class SessionFactoryFinder {
+
+    /**
+     * Private constructor.
+     */
+    private SessionFactoryFinder() {
+    }
 
     /**
      * Creates a default {@link SessionFactory} object.
+     * 
+     * @return the newly created {@link SessionFactory} object
+     * 
+     * @throws ClassNotFoundException
+     *             if the session factory class cannot be found
+     * @throws InstantiationException
+     *             if the session factory object cannot be instantiated
      */
     public static SessionFactory find() throws ClassNotFoundException, InstantiationException {
         return find("org.apache.chemistry.opencmis.client.SessionFactory", null);
@@ -42,7 +55,14 @@ public class SessionFactoryFinder {
      * Creates a {@link SessionFactory} object.
      * 
      * @param factoryId
-     *            the factory id of the {@link SessionFactory}
+     *            the factory ID of the {@link SessionFactory}
+     * 
+     * @return the newly created {@link SessionFactory} object
+     * 
+     * @throws ClassNotFoundException
+     *             if the session factory class cannot be found
+     * @throws InstantiationException
+     *             if the session factory object cannot be instantiated
      */
     public static SessionFactory find(String factoryId) throws ClassNotFoundException, InstantiationException {
         return find(factoryId, null);
@@ -52,15 +72,40 @@ public class SessionFactoryFinder {
      * Creates a {@link SessionFactory} object.
      * 
      * @param factoryId
-     *            the factory id of the {@link SessionFactory}
+     *            the factory ID of the {@link SessionFactory}
      * @param classLoader
      *            the class loader to use
+     * 
+     * @return the newly created {@link SessionFactory} object
+     * 
+     * @throws ClassNotFoundException
+     *             if the session factory class cannot be found
+     * @throws InstantiationException
+     *             if the session factory object cannot be instantiated
      */
     public static SessionFactory find(String factoryId, ClassLoader classLoader) throws ClassNotFoundException,
             InstantiationException {
         return find(factoryId, classLoader, "org.apache.chemistry.opencmis.client.runtime.SessionFactoryImpl");
     }
 
+    /**
+     * Creates a {@link SessionFactory} object.
+     * 
+     * @param factoryId
+     *            the factory ID of the {@link SessionFactory}
+     * @param classLoader
+     *            the class loader to use
+     * @param fallbackClassName
+     *            the name of the class to use if no other class name has been
+     *            provided
+     * 
+     * @return the newly created {@link SessionFactory} object
+     * 
+     * @throws ClassNotFoundException
+     *             if the session factory class cannot be found
+     * @throws InstantiationException
+     *             if the session factory object cannot be instantiated
+     */
     private static SessionFactory find(String factoryId, ClassLoader classLoader, String fallbackClassName)
             throws ClassNotFoundException, InstantiationException {
         ClassLoader cl = classLoader;

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.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/SessionParameterMap.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java Wed Oct 30 23:24:33 2013
@@ -59,7 +59,17 @@ public class SessionParameterMap extends
     }
 
     /**
-     * Sets an integer value.
+     * Creates a map with the same mappings as the specified map.
+     * 
+     * @param map
+     *            the map whose mappings are to be placed in this map
+     */
+    public SessionParameterMap(Map<? extends String, ? extends String> map) {
+        super(map);
+    }
+
+    /**
+     * Sets a long value.
      * 
      * @param key
      *            the key
@@ -163,6 +173,7 @@ public class SessionParameterMap extends
 
     /**
      * Sets whether properties should be sent in the succinct format or not.
+     * Only relevant for the browser binding.
      * 
      * @param succinct
      *            {@code true} if properties should be sent in the succinct
@@ -189,10 +200,10 @@ public class SessionParameterMap extends
     }
 
     /**
-     * Sets the repository id.
+     * Sets the repository ID.
      * 
      * @param repositoryId
-     *            the repository id
+     *            the repository ID
      */
     public void setRepositoryId(String repositoryId) {
         if (repositoryId == null) {
@@ -492,6 +503,9 @@ public class SessionParameterMap extends
      * @param file
      *            the file
      * 
+     * @throws IOException
+     *             if the entries cannot be read
+     * 
      * @see #load(InputStream)
      */
     public void load(File file) throws IOException {
@@ -514,6 +528,9 @@ public class SessionParameterMap extends
      * 
      * @param stream
      *            the stream
+     * 
+     * @throws IOException
+     *             if the entries cannot be read
      */
     public void load(InputStream stream) throws IOException {
         if (stream == null) {
@@ -567,8 +584,11 @@ public class SessionParameterMap extends
     /**
      * Writes all entries to the given file.
      * 
-     * @param stream
-     *            the stream
+     * @param file
+     *            the file
+     * 
+     * @throws IOException
+     *             if the entries cannot be written
      * 
      * @see #store(OutputStream)
      */
@@ -591,6 +611,9 @@ public class SessionParameterMap extends
      * 
      * @param stream
      *            the stream
+     * 
+     * @throws IOException
+     *             if the entries cannot be written
      */
     public void store(final OutputStream stream) throws IOException {
         if (stream == null) {

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvent.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/ChangeEvent.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvent.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvent.java Wed Oct 30 23:24:33 2013
@@ -32,22 +32,30 @@ import org.apache.chemistry.opencmis.com
 public interface ChangeEvent extends ChangeEventInfo {
 
     /**
-     * Gets the id of the object.
+     * Gets the ID of the object.
+     * 
+     * @return the object ID, not {@code null}
      */
     String getObjectId();
 
     /**
      * Returns the properties.
+     * 
+     * @return the properties
      */
     Map<String, List<?>> getProperties();
 
     /**
-     * Returns the policy ids.
+     * Returns the policy IDs.
+     * 
+     * @return the policy IDs
      */
     List<String> getPolicyIds();
 
     /**
      * Returns the ACL.
+     * 
+     * @return the ACL
      */
     Acl getAcl();
 }
\ No newline at end of file

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvents.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/ChangeEvents.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvents.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvents.java Wed Oct 30 23:24:33 2013
@@ -28,22 +28,33 @@ import java.util.List;
 public interface ChangeEvents {
 
     /**
-     * Returns the changelog token if available.
+     * Returns the change log token if available.
+     * 
+     * @return the latest change log token or {@code null} if it is not
+     *         available.
      */
     String getLatestChangeLogToken();
 
     /**
      * Returns the change event list.
+     * 
+     * @return the list of change events, not {@code null}
      */
     List<ChangeEvent> getChangeEvents();
 
     /**
      * Indicates whether are more change events or not.
+     * 
+     * @return {@code true} is there are more change events, {@code false}
+     *         otherwise
      */
     boolean getHasMoreItems();
 
     /**
      * Returns the total number of change events if available.
+     * 
+     * @return the total number of change events or -1 if the total number is
+     *         not available
      */
     long getTotalNumItems();
 }

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=1537341&r1=1537340&r2=1537341&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 Wed Oct 30 23:24:33 2013
@@ -71,8 +71,10 @@ public interface CmisObject extends Obje
      * Deletes this object.
      * 
      * @param allVersions
-     *            if this object is a document this parameter defines if only
-     *            this version or all versions should be deleted
+     *            if this object is a document this parameter defines whether
+     *            only this version ({@code false}) or all versions ({@code true}
+     *            ) should be deleted, the parameter is ignored for all other
+     *            object types
      * 
      * @cmis 1.0
      */
@@ -100,7 +102,8 @@ public interface CmisObject extends Obje
      * @param properties
      *            the properties to update
      * @param refresh
-     *            indicates if this object should be refresh after the update
+     *            {@code true} if this object should be refresh after the
+     *            update, {@code false} if not
      * 
      * @return the object id of the updated object
      * 
@@ -122,12 +125,18 @@ public interface CmisObject extends Obje
     /**
      * Applies the provided policies and refreshes this object afterwards.
      * 
+     * @param policyIds
+     *            the IDs of the policies to be applied
+     * 
      * @cmis 1.0
      */
     void applyPolicy(ObjectId... policyIds);
 
     /**
-     * Remove the provided policies and refreshes this object afterwards.
+     * Removes the provided policies and refreshes this object afterwards.
+     * 
+     * @param policyIds
+     *            the IDs of the policies to be removed
      * 
      * @cmis 1.0
      */
@@ -184,6 +193,12 @@ public interface CmisObject extends Obje
     /**
      * Returns the extensions for the given level.
      * 
+     * @param level
+     *            the level
+     * 
+     * @return the extensions at that level or {@code null} if there no
+     *         extensions
+     * 
      * @cmis 1.0
      */
     List<CmisExtensionElement> getExtensions(ExtensionLevel level);
@@ -192,30 +207,36 @@ public interface CmisObject extends Obje
 
     /**
      * Returns an adapter based on the given interface.
+     * 
+     * @return an adapter object or {@code null} if no adapter object could be
+     *         created
      */
     <T> T getAdapter(Class<T> adapterInterface);
 
     // session handling
 
     /**
-     * Returns the timestamp (in milliseconds) of the last refresh.
+     * Returns the timestamp of the last refresh.
+     * 
+     * @return the difference, measured in milliseconds, between the last
+     *         refresh time and midnight, January 1, 1970 UTC.
      */
     long getRefreshTimestamp();
 
     /**
      * Reloads this object from the repository.
-     * <p>
-     * If the object doesn't exist anymore in the repository, a
-     * {@link CmisObjectNotFoundException} is thrown.
+     * 
+     * @throws CmisObjectNotFoundException
+     *             if the object doesn't exist anymore in the repository
      */
     void refresh();
 
     /**
      * Reloads the data from the repository if the last refresh did not occur
-     * within <code>durationInMillis</code>.
-     * <p>
-     * If the object doesn't exist anymore in the repository, a
-     * {@link CmisObjectNotFoundException} is thrown.
+     * within {@code durationInMillis}.
+     * 
+     * @throws CmisObjectNotFoundException
+     *             if the object doesn't exist anymore in the repository
      */
     void refreshIfOld(long durationInMillis);
 }

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.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/CmisObjectProperties.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.java Wed Oct 30 23:24:33 2013
@@ -30,37 +30,48 @@ import org.apache.chemistry.opencmis.com
  * provide it or a property filter was used to retrieve this object.
  * <p>
  * The property values represent a snapshot of the object when it was loaded.
- * The objects and its properties can be out-of-date if the object has been
+ * The object and its properties may be out-of-date if the object has been
  * modified in the repository.
- * <p>
- * Implementations of this interface might alter property values without
- * updating the object in the repository. In this case, the values returned by
- * these accessors don't reflect the state of the object in the repository.
  */
 public interface CmisObjectProperties {
 
     /**
      * Returns a list of all available CMIS properties.
+     * 
+     * @return all available CMIS properties
      */
     List<Property<?>> getProperties();
 
     /**
-     * Returns the requested property. If the property is not available,
-     * <code>null</code> is returned.
+     * Returns a property.
+     * 
+     * @param id
+     *            the ID of the property
+     * 
+     * @return the property or {@code null} if the property hasn't been
+     *         requested or hasn't been provided by the repository
      */
     <T> Property<T> getProperty(String id);
 
     /**
-     * Returns the value of the requested property. If the property is not
-     * available, <code>null</code> is returned.
+     * Returns the value of a property.
+     * 
+     * @param id
+     *            the ID of the property
+     * 
+     * @return the property value or {@code null} if the property hasn't been
+     *         requested, hasn't been provided by the repository, or the
+     *         property value isn't set
      */
     <T> T getPropertyValue(String id);
 
     // convenience accessors
 
     /**
-     * Returns the name of this CMIS object (CMIS property
-     * <code>cmis:name</code>).
+     * Returns the name of this CMIS object (CMIS property {@code cmis:name}).
+     * 
+     * @return the name of the object or {@code null} if the property hasn't
+     *         been requested or hasn't been provided by the repository
      * 
      * @cmis 1.0
      */
@@ -68,7 +79,11 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the description of this CMIS object (CMIS property
-     * <code>cmis:description</code>).
+     * {@code cmis:description}).
+     * 
+     * @return the description of the object or {@code null} if the property
+     *         hasn't been requested, hasn't been provided by the repository, or
+     *         the property value isn't set
      * 
      * @cmis 1.1
      */
@@ -76,7 +91,10 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the user who created this CMIS object (CMIS property
-     * <code>cmis:createdBy</code>).
+     * {@code cmis:createdBy}).
+     * 
+     * @return the creator of the object or {@code null} if the property hasn't
+     *         been requested or hasn't been provided by the repository
      * 
      * @cmis 1.0
      */
@@ -84,7 +102,10 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the timestamp when this CMIS object has been created (CMIS
-     * property <code>cmis:creationDate</code>).
+     * property {@code cmis:creationDate}).
+     * 
+     * @return the creation time of the object or {@code null} if the property
+     *         hasn't been requested or hasn't been provided by the repository
      * 
      * @cmis 1.0
      */
@@ -92,7 +113,10 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the user who modified this CMIS object (CMIS property
-     * <code>cmis:lastModifiedBy</code>).
+     * {@code cmis:lastModifiedBy}).
+     * 
+     * @return the last modifier of the object or {@code null} if the property
+     *         hasn't been requested or hasn't been provided by the repository
      * 
      * @cmis 1.0
      */
@@ -100,7 +124,11 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the timestamp when this CMIS object has been modified (CMIS
-     * property <code>cmis:lastModificationDate</code>).
+     * property {@code cmis:lastModificationDate}).
+     * 
+     * @return the last modification date of the object or {@code null} if the
+     *         property hasn't been requested or hasn't been provided by the
+     *         repository
      * 
      * @cmis 1.0
      */
@@ -108,7 +136,10 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the id of the base type of this CMIS object (CMIS property
-     * <code>cmis:baseTypeId</code>).
+     * {@code cmis:baseTypeId}).
+     * 
+     * @return the base type id of the object or {@code null} if the property
+     *         hasn't been requested or hasn't been provided by the repository
      * 
      * @cmis 1.0
      */
@@ -116,7 +147,11 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the base type of this CMIS object (object type identified by
-     * <code>cmis:baseTypeId</code>).
+     * {@code cmis:baseTypeId}).
+     * 
+     * @return the base type of the object or {@code null} if the property
+     *         {@code cmis:baseTypeId} hasn't been requested or hasn't been
+     *         provided by the repository
      * 
      * @cmis 1.0
      */
@@ -124,7 +159,11 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the type of this CMIS object (object type identified by
-     * <code>cmis:objectTypeId</code>).
+     * {@code cmis:objectTypeId}).
+     * 
+     * @return the type of the object or {@code null} if the property
+     *         {@code cmis:objectTypeId} hasn't been requested or hasn't been
+     *         provided by the repository
      * 
      * @cmis 1.0
      */
@@ -132,21 +171,35 @@ public interface CmisObjectProperties {
 
     /**
      * Returns the secondary types of this CMIS object (object types identified
-     * by <code>cmis:secondaryObjectTypeIds</code>).
+     * by {@code cmis:secondaryObjectTypeIds}).
      * 
+     * @return the secondary types of the object or {@code null} if the property
+     *         {@code cmis:secondaryObjectTypeIds} hasn't been requested or
+     *         hasn't been provided by the repository
      * @cmis 1.1
      */
     List<SecondaryType> getSecondaryTypes();
 
     /**
      * Returns a list of primary and secondary object types that define the
-     * given property. If the property is not defined in any attached type,
-     * <code>null</code> is returned.
+     * given property.
+     * 
+     * @param id
+     *            the ID of the property
+     * 
+     * @return a list of object types that define the given property or
+     *         {@code null} if the property couldn't be found in the object
+     *         types that are attached to this object
+     * 
      */
     List<ObjectType> findObjectType(String id);
 
     /**
-     * Returns the change token (CMIS property <code>cmis:changeToken</code>).
+     * Returns the change token (CMIS property {@code cmis:changeToken}).
+     * 
+     * @return the change token of the object or {@code null} if the property
+     *         hasn't been requested or hasn't been provided or isn't supported
+     *         by the repository
      * 
      * @cmis 1.0
      */

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=1537341&r1=1537340&r2=1537341&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 Wed Oct 30 23:24:33 2013
@@ -46,7 +46,7 @@ public interface Document extends Fileab
     /**
      * Retrieves the content stream of this document.
      * 
-     * @return the content stream, or <code>null</code> if the document has no
+     * @return the content stream, or {@code null} if the document has no
      *         content
      * 
      * @cmis 1.0
@@ -57,12 +57,13 @@ public interface Document extends Fileab
      * Retrieves the content stream of this document.
      * 
      * @param offset
-     *            the offset of the stream or <code>null</code> to read the
-     *            stream from the beginning
+     *            the offset of the stream or {@code null} to read the stream
+     *            from the beginning
      * @param length
-     *            the maximum length of the stream or <code>null</code> to read
-     *            to the end of the stream
-     * @return the content stream, or <code>null</code> if the document has no
+     *            the maximum length of the stream or {@code null} to read to
+     *            the end of the stream
+     * 
+     * @return the content stream, or {@code null} if the document has no
      *         content
      * 
      * @cmis 1.0
@@ -70,33 +71,34 @@ public interface Document extends Fileab
     ContentStream getContentStream(BigInteger offset, BigInteger length);
 
     /**
-     * Retrieves the content stream that is associated with the given stream id.
+     * Retrieves the content stream that is associated with the given stream ID.
      * This is usually a rendition of the document.
      * 
      * @param streamId
-     *            the stream id
+     *            the stream ID
      * 
-     * @return the content stream, or <code>null</code> if no content is
-     *         associated with this stream id
+     * @return the content stream, or {@code null} if no content is associated
+     *         with this stream ID
      * 
      * @cmis 1.0
      */
     ContentStream getContentStream(String streamId);
 
     /**
-     * Retrieves the content stream that is associated with the given stream id.
+     * Retrieves the content stream that is associated with the given stream ID.
      * This is usually a rendition of the document.
      * 
      * @param streamId
-     *            the stream id
+     *            the stream ID
      * @param offset
-     *            the offset of the stream or <code>null</code> to read the
-     *            stream from the beginning
+     *            the offset of the stream or {@code null} to read the stream
+     *            from the beginning
      * @param length
-     *            the maximum length of the stream or <code>null</code> to read
-     *            to the end of the stream
-     * @return the content stream, or <code>null</code> if no content is
-     *         associated with this stream id
+     *            the maximum length of the stream or {@code null} to read to
+     *            the end of the stream
+     * 
+     * @return the content stream, or {@code null} if no content is associated
+     *         with this stream ID
      * 
      * @cmis 1.0
      */
@@ -107,18 +109,18 @@ public interface Document extends Fileab
      * afterwards. If the repository created a new version, this new document is
      * returned. Otherwise the current document is returned.
      * <p>
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
      * @param contentStream
      *            the content stream
      * @param overwrite
-     *            if this parameter is set to <code>false</code> and the
-     *            document already has content, the repository throws a
+     *            if this parameter is set to {@code false} and the document
+     *            already has content, the repository throws a
      *            {@link CmisContentAlreadyExistsException}
      * 
-     * @return the updated document, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated document, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @see ObjectFactory#createContentStream(String, long, String,
      *      java.io.InputStream)
@@ -129,24 +131,24 @@ public interface Document extends Fileab
 
     /**
      * Sets a new content stream for the document. If the repository created a
-     * new version, the object id of this new version is returned. Otherwise the
-     * object id of the current document is returned.
+     * new version, the object ID of this new version is returned. Otherwise the
+     * object ID of the current document is returned.
      * <p>
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
      * @param contentStream
      *            the content stream
      * @param overwrite
-     *            if this parameter is set to <code>false</code> and the
-     *            document already has content, the repository throws a
+     *            if this parameter is set to {@code false} and the document
+     *            already has content, the repository throws a
      *            {@link CmisContentAlreadyExistsException}
      * @param refresh
-     *            if this parameter is set to <code>true</code>, this object
-     *            will be refreshed after the new content has been set
+     *            if this parameter is set to {@code true}, this object will be
+     *            refreshed after the new content has been set
      * 
-     * @return the updated object id, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated object ID, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @see ObjectFactory#createContentStream(String, long, String,
      *      java.io.InputStream)
@@ -161,16 +163,16 @@ public interface Document extends Fileab
      * version, this new document is returned. Otherwise the current document is
      * returned.
      * <p>
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
      * @param contentStream
      *            the content stream
      * @param isLastChunk
      *            indicates if this stream is the last chunk of the content
      * 
-     * @return the updated document, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated document, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @see ObjectFactory#createContentStream(String, long, String,
      *      java.io.InputStream)
@@ -181,22 +183,22 @@ public interface Document extends Fileab
 
     /**
      * Appends a content stream to the content stream of the document. If the
-     * repository created a new version, the object id of this new version is
-     * returned. Otherwise the object id of the current document is returned.
+     * repository created a new version, the object ID of this new version is
+     * returned. Otherwise the object ID of the current document is returned.
      * <p>
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
      * @param contentStream
      *            the content stream
      * @param isLastChunk
      *            indicates if this stream is the last chunk of the content
      * @param refresh
-     *            if this parameter is set to <code>true</code>, this object
-     *            will be refreshed after the content stream has been appended
+     *            if this parameter is set to {@code true}, this object will be
+     *            refreshed after the content stream has been appended
      * 
-     * @return the updated object id, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated object ID, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @cmis 1.1
      */
@@ -207,8 +209,8 @@ public interface Document extends Fileab
      * object afterwards. If the repository created a new version, this new
      * document is returned. Otherwise the current document is returned.
      * 
-     * @return the updated document, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated document, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @cmis 1.0
      */
@@ -216,15 +218,15 @@ public interface Document extends Fileab
 
     /**
      * Removes the current content stream from the document. If the repository
-     * created a new version, the object id of this new version is returned.
-     * Otherwise the object id of the current document is returned.
+     * created a new version, the object ID of this new version is returned.
+     * Otherwise the object ID of the current document is returned.
      * 
      * @param refresh
-     *            if this parameter is set to <code>true</code>, this object
-     *            will be refreshed after the content stream has been deleted
+     *            if this parameter is set to {@code true}, this object will be
+     *            refreshed after the content stream has been deleted
      * 
-     * @return the updated document, or <code>null</code> if the repository did
-     *         not return an object id
+     * @return the updated document, or {@code null} if the repository did not
+     *         return an object ID
      * 
      * @cmis 1.0
      */
@@ -233,14 +235,14 @@ public interface Document extends Fileab
     // versioning service
 
     /**
-     * Checks out the document and returns the object id of the PWC (private
+     * Checks out the document and returns the object ID of the PWC (private
      * working copy).
      * 
-     * @return PWC object id
+     * @return PWC object ID
      * 
      * @cmis 1.0
      */
-    ObjectId checkOut(); // returns the PWC id
+    ObjectId checkOut();
 
     /**
      * If this is a PWC (private working copy) the check out will be reversed.
@@ -254,10 +256,10 @@ public interface Document extends Fileab
      * If this is a PWC (private working copy) it performs a check in. If this
      * is not a PWC it an exception will be thrown.
      * 
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
-     * @return new document id
+     * @return new document ID
      * 
      * @cmis 1.0
      */
@@ -268,10 +270,10 @@ public interface Document extends Fileab
      * If this is a PWC (private working copy) it performs a check in. If this
      * is not a PWC it an exception will be thrown.
      * 
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
-     * @return new document id
+     * @return new document ID
      * 
      * @cmis 1.0
      */
@@ -281,8 +283,8 @@ public interface Document extends Fileab
      * Fetches the latest major or minor version of this document.
      * 
      * @param major
-     *            if <code>true</code> the latest major version will be
-     *            returned, otherwise the very last version will be returned
+     *            if {@code true} the latest major version will be returned,
+     *            otherwise the very last version will be returned
      * 
      * @return the latest document object
      * 
@@ -295,8 +297,8 @@ public interface Document extends Fileab
      * given {@link OperationContext}.
      * 
      * @param major
-     *            if <code>true</code> the latest major version will be
-     *            returned, otherwise the very last version will be returned
+     *            if {@code true} the latest major version will be returned,
+     *            otherwise the very last version will be returned
      * 
      * @return the latest document object
      * 
@@ -306,6 +308,13 @@ public interface Document extends Fileab
 
     /**
      * Fetches all versions of this document.
+     * <p>
+     * The behavior of this method is undefined if the document is not
+     * versionable and can be different for each repository.
+     * 
+     * @return all versions of the version series, sorted by
+     *         {@code cmis:creationDate} descending and preceded by the PWC, if
+     *         one exists, not {@code null}
      * 
      * @cmis 1.0
      */
@@ -314,6 +323,13 @@ public interface Document extends Fileab
     /**
      * Fetches all versions of this document using the given
      * {@link OperationContext}.
+     * <p>
+     * The behavior of this method is undefined if the document is not
+     * versionable and can be different for each repository.
+     * 
+     * @return all versions of the version series, sorted by
+     *         {@code cmis:creationDate} descending and preceded by the PWC, if
+     *         one exists, not {@code null}
      * 
      * @cmis 1.0
      */
@@ -322,6 +338,10 @@ public interface Document extends Fileab
     /**
      * Creates a copy of this document, including content.
      * 
+     * @param targetFolderId
+     *            the ID of the target folder, {@code null} to create an unfiled
+     *            document
+     * 
      * @return the new document object
      * 
      * @cmis 1.0
@@ -331,6 +351,10 @@ public interface Document extends Fileab
     /**
      * Creates a copy of this document, including content.
      * 
+     * @param targetFolderId
+     *            the ID of the target folder, {@code null} to create an unfiled
+     *            document
+     * 
      * @return the new document object or {@code null} if the parameter
      *         {@code context} was set to {@code null}
      * 

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/DocumentProperties.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/DocumentProperties.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/DocumentProperties.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/DocumentProperties.java Wed Oct 30 23:24:33 2013
@@ -26,63 +26,95 @@ package org.apache.chemistry.opencmis.cl
 public interface DocumentProperties {
 
     /**
-     * Returns <code>true</code> if this CMIS object is immutable (CMIS property
-     * <code>cmis:isImmutable</code>).
+     * Returns {@code true} if this document is immutable (CMIS property
+     * {@code cmis:isImmutable}).
+     * 
+     * @return the immutable flag of the document or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     Boolean isImmutable();
 
     /**
-     * Returns if this CMIS object is the latest version (CMIS property
-     * <code>cmis:isLatestVersion</code>).
+     * Returns {@code true} if this document is the latest version (CMIS
+     * property {@code cmis:isLatestVersion}).
+     * 
+     * @return the latest version flag of the document or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     Boolean isLatestVersion();
 
     /**
-     * Returns <code>true</code> if this CMIS object is the latest version (CMIS
-     * property <code>cmis:isMajorVersion</code>).
+     * Returns {@code true} if this document is a major version (CMIS property
+     * {@code cmis:isMajorVersion}).
+     * 
+     * @return the major version flag of the document or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     Boolean isMajorVersion();
 
     /**
-     * Returns <code>true</code> if this CMIS object is the latest major version
-     * (CMIS property <code>cmis:isLatestMajorVersion</code>).
+     * Returns {@code true} if this document is the latest major version (CMIS
+     * property {@code cmis:isLatestMajorVersion}).
+     * 
+     * @return the latest major version flag of the document or {@code null} if
+     *         the property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     Boolean isLatestMajorVersion();
 
     /**
-     * Returns <code>true</code> if this CMIS object is the PWC (CMIS property
-     * <code>cmis:isPrivateWorkingCopy</code>).
+     * Returns {@code true} if this document is the PWC (CMIS property
+     * {@code cmis:isPrivateWorkingCopy}).
      * 
-     * @cmis 1.0
+     * @return the PWC flag of the document or {@code null} if the property
+     *         hasn't been requested, hasn't been provided by the repository, or
+     *         the property value isn't set
+     * 
+     * @cmis 1.1
      */
     Boolean isPrivateWorkingCopy();
 
     /**
-     * Returns the version label (CMIS property <code>cmis:versionLabel</code>).
+     * Returns the version label (CMIS property {@code cmis:versionLabel}).
+     * 
+     * @return the version label of the document or {@code null} if the property
+     *         hasn't been requested, hasn't been provided by the repository, or
+     *         the property value isn't set
      * 
      * @cmis 1.0
      */
     String getVersionLabel();
 
     /**
-     * Returns the version series id (CMIS property
-     * <code>cmis:versionSeriesId</code>).
+     * Returns the version series ID (CMIS property {@code cmis:versionSeriesId}
+     * ).
+     * 
+     * @return the version series ID of the document or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     String getVersionSeriesId();
 
     /**
-     * Returns <code>true</code> if this version series is checked out (CMIS
-     * property <code>cmis:isVersionSeriesCheckedOut</code>).
+     * Returns {@code true} if this version series is checked out (CMIS property
+     * {@code cmis:isVersionSeriesCheckedOut}).
+     * 
+     * @return the version series checked out flag of the document or
+     *         {@code null} if the property hasn't been requested, hasn't been
+     *         provided by the repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
@@ -90,21 +122,37 @@ public interface DocumentProperties {
 
     /**
      * Returns the user who checked out this version series (CMIS property
-     * <code>cmis:versionSeriesCheckedOutBy</code>).
+     * {@code cmis:versionSeriesCheckedOutBy}).
+     * 
+     * @return the user who checked out this version series or {@code null} if
+     *         the property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
     String getVersionSeriesCheckedOutBy();
 
     /**
-     * Returns the PWC id of this version series (CMIS property
-     * <code>cmis:versionSeriesCheckedOutId</code>).
+     * Returns the PWC ID of this version series (CMIS property
+     * {@code cmis:versionSeriesCheckedOutId}).
+     * <p>
+     * Some repositories provided this value only to the user who checked out
+     * the version series.
+     * 
+     * @return the PWC ID of this version series or {@code null} if the property
+     *         hasn't been requested, hasn't been provided by the repository, or
+     *         the property value isn't set
+     * 
+     * @cmis 1.0
      */
     String getVersionSeriesCheckedOutId();
 
     /**
-     * Returns the checkin comment (CMIS property
-     * <code>cmis:checkinComment</code>).
+     * Returns the checkin comment (CMIS property {@code cmis:checkinComment}).
+     * 
+     * @return the checkin comment of this version or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the property value isn't set
      * 
      * @cmis 1.0
      */
@@ -112,31 +160,46 @@ public interface DocumentProperties {
 
     /**
      * Returns the content stream length or -1 if the document has no content
-     * (CMIS property <code>cmis:contentStreamLength</code>).
+     * (CMIS property {@code cmis:contentStreamLength}).
+     * 
+     * @return the content stream length of this document or -1 if the property
+     *         hasn't been requested, hasn't been provided by the repository, or
+     *         the document has no content
      * 
      * @cmis 1.0
      */
     long getContentStreamLength();
 
     /**
-     * Returns the content stream MIME type or <code>null</code> if the document
-     * has no content (CMIS property <code>cmis:contentStreamMimeType</code>).
+     * Returns the content stream MIME type or {@code null} if the document has
+     * no content (CMIS property {@code cmis:contentStreamMimeType}).
+     * 
+     * @return the content stream MIME type of this document or {@code null} if
+     *         the property hasn't been requested, hasn't been provided by the
+     *         repository, or the document has no content
      * 
      * @cmis 1.0
      */
     String getContentStreamMimeType();
 
     /**
-     * Returns the content stream filename or <code>null</code> if the document
-     * has no content (CMIS property <code>cmis:contentStreamFileName</code>).
+     * Returns the content stream filename or {@code null} if the document has
+     * no content (CMIS property {@code cmis:contentStreamFileName}).
      * 
+     * @return the content stream filename of this document or {@code null} if
+     *         the property hasn't been requested, hasn't been provided by the
+     *         repository, or the document has no content
      * @cmis 1.0
      */
     String getContentStreamFileName();
 
     /**
-     * Returns the content stream id or <code>null</code> if the document has no
-     * content (CMIS property <code>cmis:contentStreamId</code>).
+     * Returns the content stream ID or {@code null} if the document has no
+     * content (CMIS property {@code cmis:contentStreamId}).
+     * 
+     * @return the content stream ID of this document or {@code null} if the
+     *         property hasn't been requested, hasn't been provided by the
+     *         repository, or the document has no content
      * 
      * @cmis 1.0
      */

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FileableCmisObject.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/FileableCmisObject.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FileableCmisObject.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FileableCmisObject.java Wed Oct 30 23:24:33 2013
@@ -22,6 +22,8 @@ import java.util.List;
 
 /**
  * Fileable CMIS object.
+ * 
+ * A fileable object is an object that can reside in a folder.
  */
 public interface FileableCmisObject extends CmisObject {
 
@@ -31,9 +33,9 @@ public interface FileableCmisObject exte
      * Moves this object.
      * 
      * @param sourceFolderId
-     *            the object id of the source folder
+     *            the object ID of the source folder
      * @param targetFolderId
-     *            the object id of the target folder
+     *            the object ID of the target folder
      * 
      * @return the moved object
      * 
@@ -45,9 +47,9 @@ public interface FileableCmisObject exte
      * Moves this object.
      * 
      * @param sourceFolderId
-     *            the object id of the source folder
+     *            the object ID of the source folder
      * @param targetFolderId
-     *            the object id of the target folder
+     *            the object ID of the target folder
      * @param context
      *            the {@link OperationContext} to use to fetch the moved object
      * 
@@ -99,14 +101,13 @@ public interface FileableCmisObject exte
      * Adds this object to a folder.
      * 
      * @param folderId
-     *            the object id of the folder to which this object should be
+     *            the object ID of the folder to which this object should be
      *            added
      * @param allVersions
-     *            if this parameter is <code>true</code> and this object is a
+     *            if this parameter is {@code true} and this object is a
      *            document, all versions of the version series are added to the
      *            folder
      * 
-     * 
      * @cmis 1.0
      */
     void addToFolder(ObjectId folderId, boolean allVersions);
@@ -115,7 +116,7 @@ public interface FileableCmisObject exte
      * Removes this object from a folder.
      * 
      * @param folderId
-     *            the object id of the folder from which this object should be
+     *            the object ID of the folder from which this object should be
      *            removed
      * 
      * @cmis 1.0

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Folder.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/Folder.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Folder.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Folder.java Wed Oct 30 23:24:33 2013
@@ -38,11 +38,11 @@ public interface Folder extends Fileable
     /**
      * Creates a new document in this folder.
      * 
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
-     * @return the new document object or <code>null</code> if the parameter
-     *         <code>context</code> was set to <code>null</code>
+     * @return the new document object or {@code null} if the parameter
+     *         {@code context} was set to {@code null}
      * 
      * @cmis 1.0
      */
@@ -52,8 +52,8 @@ public interface Folder extends Fileable
     /**
      * Creates a new document in this folder.
      * 
-     * The stream in <code>contentStream</code> is consumed but not closed by
-     * this method.
+     * The stream in {@code contentStream} is consumed but not closed by this
+     * method.
      * 
      * @return the new document object
      * 
@@ -64,8 +64,8 @@ public interface Folder extends Fileable
     /**
      * Creates a new document from a source document in this folder.
      * 
-     * @return the new document object or <code>null</code> if the parameter
-     *         <code>context</code> was set to <code>null</code>
+     * @return the new document object or {@code null} if the parameter
+     *         {@code context} was set to {@code null}
      * 
      * @cmis 1.0
      */
@@ -84,8 +84,8 @@ public interface Folder extends Fileable
     /**
      * Creates a new subfolder in this folder.
      * 
-     * @return the new folder object or <code>null</code> if the parameter
-     *         <code>context</code> was set to <code>null</code>
+     * @return the new folder object or {@code null} if the parameter
+     *         {@code context} was set to {@code null}
      * 
      * @cmis 1.0
      */
@@ -104,8 +104,8 @@ public interface Folder extends Fileable
     /**
      * Creates a new policy in this folder.
      * 
-     * @return the new policy object or <code>null</code> if the parameter
-     *         <code>context</code> was set to <code>null</code>
+     * @return the new policy object or {@code null} if the parameter
+     *         {@code context} was set to {@code null}
      * 
      * @cmis 1.0
      */
@@ -124,8 +124,8 @@ public interface Folder extends Fileable
     /**
      * Creates a new item in this folder.
      * 
-     * @return the new item object or <code>null</code> if the parameter
-     *         <code>context</code> was set to <code>null</code>
+     * @return the new item object or {@code null} if the parameter
+     *         {@code context} was set to {@code null}
      * 
      * @cmis 1.1
      */
@@ -144,7 +144,7 @@ public interface Folder extends Fileable
     /**
      * Deletes this folder and all subfolders.
      * 
-     * @return a list of object ids which failed to be deleted
+     * @return a list of object IDs which failed to be deleted
      * 
      * @cmis 1.0
      */
@@ -200,15 +200,18 @@ public interface Folder extends Fileable
     /**
      * Returns if the folder is the root folder.
      * 
+     * @return {@code true} if the folder is the root folder, {@code false}
+     *         otherwise
+     * 
      * @cmis 1.0
      */
     boolean isRootFolder();
 
     /**
-     * Gets the parent folder object
+     * Gets the parent folder object.
      * 
-     * @return the parent folder object or <code>null</code> if the folder is
-     *         the root folder.
+     * @return the parent folder object or {@code null} if the folder is the
+     *         root folder.
      * 
      * @cmis 1.0
      */
@@ -217,6 +220,8 @@ public interface Folder extends Fileable
     /**
      * Returns the path of the folder.
      * 
+     * @return the absolute folder path
+     * 
      * @cmis 1.0
      */
     String getPath();

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FolderProperties.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/FolderProperties.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FolderProperties.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/FolderProperties.java Wed Oct 30 23:24:33 2013
@@ -28,8 +28,12 @@ import java.util.List;
 public interface FolderProperties {
 
     /**
-     * Returns the parent id or <code>null</code> if the folder is ther root
-     * folder (CMIS property <code>cmis:parentId</code>).
+     * Returns the parent id or {@code null} if the folder is the root folder
+     * (CMIS property {@code cmis:parentId}).
+     * 
+     * @return the property value or {@code null} if the property hasn't been
+     *         requested, hasn't been provided by the repository, or the folder
+     *         is the root folder
      * 
      * @cmis 1.0
      */
@@ -37,8 +41,12 @@ public interface FolderProperties {
 
     /**
      * Returns the list of the allowed object types in this folder (CMIS
-     * property <code>cmis:allowedChildObjectTypeIds</code>). If the list is
-     * empty or <code>null</code> all object types are allowed.
+     * property {@code cmis:allowedChildObjectTypeIds}). If the list is empty or
+     * {@code null} all object types are allowed.
+     * 
+     * @return the property value or {@code null} if the property hasn't been
+     *         requested, hasn't been provided by the repository, or the
+     *         property value isn't set
      * 
      * @cmis 1.0
      */

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.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/ItemIterable.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java Wed Oct 30 23:24:33 2013
@@ -23,56 +23,54 @@ import java.util.Iterator;
 /**
  * Iterable for CMIS collections that allows ability to skip to specific
  * position or return a subcollection.
- *
- * @param <T> the type of the items
+ * 
+ * @param <T>
+ *            the type of the items
  */
 public interface ItemIterable<T> extends Iterable<T> {
 
     /**
-     * Skip to position within CMIS collection
-     *
+     * Skips to position within CMIS collection.
+     * 
      * @param position
+     * 
      * @return iterable whose starting point is the specified skip to position.
      *         This iterable <em>may</em> be the same as {@code this}
      */
     ItemIterable<T> skipTo(long position);
 
     /**
-     * Gets an iterable for the current sub collection within the CMIS collection using
-     * default maximum number of items
-     *
+     * Gets an iterable for the current sub collection within the CMIS
+     * collection using default maximum number of items.
+     * 
      * @return iterable for current page
      */
     ItemIterable<T> getPage();
 
     /**
-     * Gets an iterable for the current sub collection within the CMIS collection
-     *
+     * Gets an iterable for the current sub collection within the CMIS
+     * collection.
+     * 
      * @param maxNumItems
      *            maximum number of items the sub collection will contain
-     *
+     * 
      * @return iterable for current page
      */
     ItemIterable<T> getPage(int maxNumItems);
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Iterable#iterator()
-     */
     Iterator<T> iterator();
 
     /**
      * Returns the number of items fetched for the current page.
-     *
+     * 
      * @return number of items for currently fetched collection
      */
     long getPageNumItems();
 
     /**
-     * Returns whether the repository contains additional items beyond the page of
-     * items already fetched.
-     *
+     * Returns whether the repository contains additional items beyond the page
+     * of items already fetched.
+     * 
      * @return true => further page requests will be made to the repository
      */
     boolean getHasMoreItems();
@@ -84,7 +82,7 @@ public interface ItemIterable<T> extends
      * set, this parameter SHOULD not be set. The value in the parameter MAY NOT
      * be accurate the next time the client retrieves the result set or the next
      * page in the result set.
-     *
+     * 
      * @return total number of items or (-1)
      */
     long getTotalNumItems();

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectId.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/ObjectId.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectId.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectId.java Wed Oct 30 23:24:33 2013
@@ -19,12 +19,14 @@
 package org.apache.chemistry.opencmis.client.api;
 
 /**
- * Holds an object id.
+ * Holds an object ID.
  */
 public interface ObjectId {
 
     /**
-     * Returns the object id.
+     * Returns the object ID.
+     * 
+     * @return the object ID
      */
     String getId();
 }

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectType.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/ObjectType.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectType.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ObjectType.java Wed Oct 30 23:24:33 2013
@@ -21,8 +21,6 @@ package org.apache.chemistry.opencmis.cl
 import java.util.List;
 
 import org.apache.chemistry.opencmis.commons.definitions.TypeDefinition;
-import org.apache.chemistry.opencmis.commons.enums.BaseTypeId;
-import org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
 
 /**
  * Object Type.
@@ -31,62 +29,55 @@ import org.apache.chemistry.opencmis.com
  */
 public interface ObjectType extends TypeDefinition {
 
-    String DOCUMENT_BASETYPE_ID = BaseTypeId.CMIS_DOCUMENT.value();
-    String FOLDER_BASETYPE_ID = BaseTypeId.CMIS_FOLDER.value();
-    String RELATIONSHIP_BASETYPE_ID = BaseTypeId.CMIS_RELATIONSHIP.value();
-    String POLICY_BASETYPE_ID = BaseTypeId.CMIS_POLICY.value();
-
     /**
-     * Indicates if this is base object type (i.e. if {@code getId()} returns
-     * ...{@code _BASETYPE_ID}.
+     * Indicates whether this is base object type or not.
      * 
      * @return {@code true} if this type is a base type, {@code false} if this
-     *         type is a derived type.
+     *         type is a derived type
      * 
      * @cmis 1.0
      */
     boolean isBaseType();
 
     /**
-     * Get the type's base type, if the type is a derived (non-base) type.
+     * Gets the types base type, if the type is a derived (non-base) type.
      * 
      * @return the base type this type is derived from, or {@code null} if it is
-     *         a base type ({@code isBase()==true}).
-     * @throws CmisRuntimeException
+     *         a base type
      * 
      * @cmis 1.0
      */
-    ObjectType getBaseType(); // null if isBase == true
+    ObjectType getBaseType();
 
     /**
-     * Get the type's parent type, if the type is a derived (non-base) type.
+     * Gets the types parent type, if the type is a derived (non-base) type.
      * 
      * @return the parent type from which this type is derived, or {@code null}
-     *         if it is a base type ( {@code isBase()==true}).
-     * @throws CmisRuntimeException
+     *         if it is a base type
      * 
      * @cmis 1.0
      */
     ObjectType getParentType();
 
     /**
-     * Get the list of types directly derived from this type (which will return
+     * Gets the list of types directly derived from this type (which will return
      * this type on {@code getParent()}).
      * 
-     * @return a {@code List} of types which are directly derived from this
-     *         type.
+     * @return list of types which are directly derived from this type
      * 
      * @cmis 1.0
      */
     ItemIterable<ObjectType> getChildren();
 
     /**
-     * Get the list of all types somehow derived from this type.
+     * Gets the list of all types somehow derived from this type.
      * 
      * @param depth
-     *            the depth to which the derived types should be resolved.
-     * @return a {@code Tree} of types which are derived from this type (direct
-     *         and via their parents).
+     *            the tree depth, must be greater than 0 or -1 for infinite
+     *            depth
+     * 
+     * @return a list of trees of types which are derived from this type (direct
+     *         and via their parents)
      * 
      * @cmis 1.0
      */

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/OperationContext.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/OperationContext.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/OperationContext.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/OperationContext.java Wed Oct 30 23:24:33 2013
@@ -48,7 +48,9 @@ public interface OperationContext extend
      * Sets the current filter.
      * 
      * @param propertyFilter
-     *            a comma separated list of <em>query names</em>
+     *            a comma separated string of <em>query names</em> or "*" for
+     *            all properties or {@code null} to let the repository determine
+     *            a set of properties
      */
     void setFilterString(String propertyFilter);
 

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/PolicyProperties.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/PolicyProperties.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/PolicyProperties.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/PolicyProperties.java Wed Oct 30 23:24:33 2013
@@ -27,7 +27,11 @@ public interface PolicyProperties {
 
     /**
      * Returns the policy text of this CMIS policy (CMIS property
-     * <code>cmis:policyText</code>).
+     * {@code cmis:policyText}).
+     * 
+     * @return the policy text or {@code null} if the property hasn't been
+     *         requested, hasn't been provided by the repository, or the
+     *         property value isn't set
      * 
      * @cmis 1.0
      */

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Property.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/Property.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Property.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Property.java Wed Oct 30 23:24:33 2013
@@ -29,32 +29,48 @@ public interface Property<T> extends Pro
 
     /**
      * Returns if the property is a multi-value property.
+     * 
+     * @return {@code true} if the property is multi-value property,
+     *         {@code false} if the property is single-value property,
      */
     boolean isMultiValued();
 
     /**
      * Returns the property data type.
+     * 
+     * @return the data type of the property, not {@code null}
      */
     PropertyType getType();
 
     /**
      * Returns the property definition.
+     * 
+     * @return the property definition, not {@code null}
      */
     PropertyDefinition<T> getDefinition();
 
     /**
      * Returns the property value (single or multiple).
+     * 
+     * @return the property value or {@code null} if the property value isn't
+     *         set
      */
     <U> U getValue();
 
     /**
      * Returns a human readable representation of the property value. If the
      * property is multi-value property, only the first value will be returned.
+     * 
+     * @return the (first) property value as a string or {@code null} if the
+     *         property value isn't set
      */
     String getValueAsString();
 
     /**
      * Returns a human readable representation of the property values.
+     * 
+     * @return the property value as a string or {@code null} if the property
+     *         value isn't set
      */
     String getValuesAsString();
 }

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryResult.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/QueryResult.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryResult.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryResult.java Wed Oct 30 23:24:33 2013
@@ -29,26 +29,44 @@ import org.apache.chemistry.opencmis.com
 public interface QueryResult {
 
     /**
-     * Returns a list of all properties in this query result.
+     * Returns the list of all properties in this query result.
+     * 
+     * @return all properties, not {@code null}
      */
     List<PropertyData<?>> getProperties();
 
     /**
-     * Returns a property by id.
+     * Returns a property by ID.
      * <p>
-     * Since repositories are not obligated to add property ids to their query
+     * Because repositories are not obligated to add property IDs to their query
      * result properties, this method might not always work as expected with
      * some repositories. Use {@link #getPropertyByQueryName(String)} instead.
+     * 
+     * @param id
+     *            the property ID
+     * 
+     * @return the property or {@code null} if the property doesn't exist or
+     *         hasn't been requested
      */
     <T> PropertyData<T> getPropertyById(String id);
 
     /**
      * Returns a property by query name or alias.
+     * 
+     * @param queryName
+     *            the property query name or alias
+     * 
+     * @return the property or {@code null} if the property doesn't exist or
+     *         hasn't been requested
+     * 
      */
     <T> PropertyData<T> getPropertyByQueryName(String queryName);
 
     /**
-     * Returns a property (single) value by id.
+     * Returns a property (single) value by ID.
+     * 
+     * @param id
+     *            the property ID
      * 
      * @see #getPropertyById(String)
      */
@@ -57,12 +75,24 @@ public interface QueryResult {
     /**
      * Returns a property (single) value by query name or alias.
      * 
+     * @param queryName
+     *            the property query name or alias
+     * 
+     * @return the property value or {@code null} if the property doesn't exist,
+     *         hasn't been requested, or the property value isn't set
+     * 
      * @see #getPropertyByQueryName(String)
      */
     <T> T getPropertyValueByQueryName(String queryName);
 
     /**
-     * Returns a property multi-value by id.
+     * Returns a property multi-value by ID.
+     * 
+     * @param id
+     *            the property ID
+     * 
+     * @return the property value or {@code null} if the property doesn't exist,
+     *         hasn't been requested, or the property value isn't set
      * 
      * @see #getPropertyById(String)
      */
@@ -71,22 +101,36 @@ public interface QueryResult {
     /**
      * Returns a property multi-value by query name or alias.
      * 
+     * @param queryName
+     *            the property query name or alias
+     * 
+     * @return the property value or {@code null} if the property doesn't exist,
+     *         hasn't been requested, or the property value isn't set
+     * 
      * @see #getPropertyByQueryName(String)
      */
     <T> List<T> getPropertyMultivalueByQueryName(String queryName);
 
     /**
-     * Returns the allowable actions if they were requested.
+     * Returns the allowable actions if they have been requested.
+     * 
+     * @return the allowable actions if they have been requested, {@code null}
+     *         otherwise
      */
     AllowableActions getAllowableActions();
 
     /**
-     * Returns the relationships if they were requested.
+     * Returns the relationships if they have been requested.
+     * 
+     * @returns the relationships if they have been requested, {@code null}
+     *          otherwise
      */
     List<Relationship> getRelationships();
 
     /**
-     * Returns the renditions if they were requested.
+     * Returns the renditions if they have been requested.
+     * 
+     * @eturns the rendition if they have been requested, {@code null} otherwise
      */
     List<Rendition> getRenditions();
 }

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryStatement.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/QueryStatement.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryStatement.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/QueryStatement.java Wed Oct 30 23:24:33 2013
@@ -59,38 +59,59 @@ import org.apache.chemistry.opencmis.com
 public interface QueryStatement extends Cloneable {
 
     /**
-     * Sets the designated parameter to the query name of the given type id.
+     * Sets the designated parameter to the query name of the given type ID.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setType(int parameterIndex, String typeId);
 
     /**
      * Sets the designated parameter to the query name of the given type.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setType(int parameterIndex, ObjectType type);
 
     /**
      * Sets the designated parameter to the query name of the given property.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setProperty(int parameterIndex, String typeId, String propertyId);
 
     /**
      * Sets the designated parameter to the query name of the given property.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setProperty(int parameterIndex, PropertyDefinition<?> propertyDefinition);
 
     /**
      * Sets the designated parameter to the given number.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setNumber(int parameterIndex, Number... num);
 
     /**
      * Sets the designated parameter to the given string.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setString(int parameterIndex, String... str);
 
     /**
      * Sets the designated parameter to the given string. It does not escape
      * backslashes ('\') in front of '%' and '_'.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setStringLike(int parameterIndex, String str);
 
@@ -111,64 +132,99 @@ public interface QueryStatement extends 
      * output): * --> * --> * ? --> ? --> ? - --> - --> - \ --> \\ --> \\\\ (for
      * any other character following other than * ? -) \* --> \* --> \\* \? -->
      * \? --> \\? \- --> \- --> \\- ' --> \' --> \\\' " --> \" --> \\\"
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setStringContains(int parameterIndex, String str);
 
     /**
-     * Sets the designated parameter to the given object id.
+     * Sets the designated parameter to the given object ID.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setId(int parameterIndex, ObjectId... id);
 
     /**
      * Sets the designated parameter to the given URI.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setUri(int parameterIndex, URI... uri);
 
     /**
      * Sets the designated parameter to the given URL.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setUrl(int parameterIndex, URL... url);
 
     /**
      * Sets the designated parameter to the given boolean.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setBoolean(int parameterIndex, boolean... bool);
 
     /**
      * Sets the designated parameter to the given DateTime value.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTime(int parameterIndex, Calendar... cal);
 
     /**
      * Sets the designated parameter to the given DateTime value.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTime(int parameterIndex, Date... date);
 
     /**
      * Sets the designated parameter to the given DateTime value.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTime(int parameterIndex, long... ms);
 
     /**
      * Sets the designated parameter to the given DateTime value with the prefix
      * 'TIMESTAMP '.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTimeTimestamp(int parameterIndex, Calendar... cal);
 
     /**
      * Sets the designated parameter to the given DateTime value with the prefix
      * 'TIMESTAMP '.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTimeTimestamp(int parameterIndex, Date... date);
 
     /**
      * Sets the designated parameter to the given DateTime value with the prefix
      * 'TIMESTAMP '.
+     * 
+     * @param parameterIndex
+     *            the parameter index (one-based)
      */
     void setDateTimeTimestamp(int parameterIndex, long... ms);
 
     /**
      * Returns the query statement.
+     * 
+     * @return the query statement, not {@code null}
      */
     String toQueryString();
 

Modified: chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Relationship.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/Relationship.java?rev=1537341&r1=1537340&r2=1537341&view=diff
==============================================================================
--- chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Relationship.java (original)
+++ chemistry/opencmis/trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/Relationship.java Wed Oct 30 23:24:33 2013
@@ -26,26 +26,26 @@ package org.apache.chemistry.opencmis.cl
 public interface Relationship extends CmisObject, RelationshipProperties {
 
     /**
-     * Gets the source object. If the source object id is invalid,
-     * <code>null</code> will be returned.
+     * Gets the source object. If the source object ID is invalid,
+     * {@code null} will be returned.
      */
     CmisObject getSource();
 
     /**
      * Gets the source object using the given {@link OperationContext}. If the
-     * source object id is invalid, <code>null</code> will be returned.
+     * source object ID is invalid, {@code null} will be returned.
      */
     CmisObject getSource(OperationContext context);
 
     /**
-     * Gets the target object. If the target object id is invalid,
-     * <code>null</code> will be returned.
+     * Gets the target object. If the target object ID is invalid,
+     * {@code null} will be returned.
      */
     CmisObject getTarget();
 
     /**
      * Gets the target object using the given {@link OperationContext}. If the
-     * target object id is invalid, <code>null</code> will be returned.
+     * target object ID is invalid, {@code null} will be returned.
      */
     CmisObject getTarget(OperationContext context);
 }



Mime
View raw message