You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@chemistry.apache.org by fm...@apache.org on 2010/05/25 16:34:33 UTC
svn commit: r948062 - in
/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons:
data/ definitions/ enums/ exceptions/ server/ spi/
Author: fmui
Date: Tue May 25 14:34:33 2010
New Revision: 948062
URL: http://svn.apache.org/viewvc?rev=948062&view=rev
Log:
a bit more JavaDoc
Added:
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/package.html
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/package.html
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/enums/package.html
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/package.html
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/package.html
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/package.html
Modified:
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/Holder.java
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java
incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,29 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS data interfaces.
+<p>This package contains the interfaces for classes that transport
+data.</p>
+</body>
+</html>
\ No newline at end of file
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,29 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS type and property definition interfaces.
+<p>This package contains the interfaces for type and property
+definitions.</p>
+</body>
+</html>
\ No newline at end of file
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/enums/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/enums/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/enums/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/enums/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,28 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS enums.
+<p>This package contains all enums used by OpenCMIS.</p>
+</body>
+</html>
\ No newline at end of file
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,28 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS exceptions.
+<p>This package contains all exceptions used by OpenCMIS.</p>
+</body>
+</html>
\ No newline at end of file
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,28 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS server interfaces.
+<p>This package contains the server interfaces.</p>
+</body>
+</html>
\ No newline at end of file
Modified: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/Holder.java
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/Holder.java?rev=948062&r1=948061&r2=948062&view=diff
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/Holder.java (original)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/Holder.java Tue May 25 14:34:33 2010
@@ -18,6 +18,9 @@
*/
package org.apache.chemistry.opencmis.commons.spi;
+/**
+ * Holder for IN/OUT parameters.
+ */
public final class Holder<T> {
private T fValue;
Modified: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java?rev=948062&r1=948061&r2=948062&view=diff
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java (original)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java Tue May 25 14:34:33 2010
@@ -46,6 +46,33 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
+ * @param folderId
+ * the identifier for the folder
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param orderBy
+ * <em>(optional)</em> a comma-separated list of query names that
+ * define the order of the result set. Each query name must be
+ * followed by the ascending modifier "ASC" or the descending
+ * modifier "DESC" (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for each object in the
+ * result set (default is <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * objects participate must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includePathSegment
+ * <em>(optional)</em> if <code>true</code>, returns a path
+ * segment for each child object for use in constructing that
+ * object's path (default is <code>false</code>)
* @param maxItems
* <em>(optional)</em> the maximum number of items to return in a
* response (default is repository specific)
@@ -64,7 +91,32 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
- */
+ * @param folderId
+ * the identifier for the folder
+ * @param depth
+ * the number of levels of depth in the folder hierarchy from
+ * which to return results
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for each object in the
+ * result set (default is <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * objects participate must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includePathSegment
+ * <em>(optional)</em> if <code>true</code>, returns a path
+ * segment for each child object for use in constructing that
+ * object's path (default is <code>false</code>)
+ **/
List<ObjectInFolderContainer> getDescendants(String repositoryId, String folderId, BigInteger depth, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
Boolean includePathSegment, ExtensionsData extension);
@@ -75,7 +127,32 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
- */
+ * @param folderId
+ * the identifier for the folder
+ * @param depth
+ * the number of levels of depth in the folder hierarchy from
+ * which to return results
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for each object in the
+ * result set (default is <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * objects participate must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includePathSegment
+ * <em>(optional)</em> if <code>true</code>, returns a path
+ * segment for each child object for use in constructing that
+ * object's path (default is <code>false</code>)
+ **/
List<ObjectInFolderContainer> getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
Boolean includePathSegment, ExtensionsData extension);
@@ -85,6 +162,28 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for each object in the
+ * result set (default is <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * objects participate must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includeRelativePathSegment
+ * <em>(optional)</em> if <code>true</code>, returns a relative
+ * path segment for each parent object for use in constructing
+ * that object's path (default is <code>false</code>)
*/
List<ObjectParentData> getObjectParents(String repositoryId, String objectId, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
@@ -95,6 +194,12 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
+ * @param folderId
+ * the identifier for the folder
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
*/
ObjectData getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension);
@@ -104,6 +209,29 @@ public interface NavigationService {
*
* @param repositoryId
* the identifier for the repository
+ * @param folderId
+ * the identifier for the folder
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param orderBy
+ * <em>(optional)</em> a comma-separated list of query names that
+ * define the order of the result set. Each query name must be
+ * followed by the ascending modifier "ASC" or the descending
+ * modifier "DESC" (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for each object in the
+ * result set (default is <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * objects participate must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
* @param maxItems
* <em>(optional)</em> the maximum number of items to return in a
* response (default is repository specific)
Modified: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java?rev=948062&r1=948061&r2=948062&view=diff
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java (original)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java Tue May 25 14:34:33 2010
@@ -52,29 +52,29 @@ public interface ObjectService {
* @param repositoryId
* the identifier for the repository
* @param properties
- * the property values that MUST be applied to the newly created
+ * the property values that must be applied to the newly created
* document object
* @param folderId
* <em>(optional)</em> if specified, the identifier for the
- * folder that MUST be the parent folder for the newly created
+ * folder that must be the parent folder for the newly created
* document object
* @param contentStream
- * <em>(optional)</em> the content stream that MUST be stored for
+ * <em>(optional)</em> the content stream that must be stored for
* the newly created document object
* @param versioningState
* <em>(optional)</em> specifies what the versioning state of the
- * newly created object MUST be (default is
+ * newly created object must be (default is
* {@link VersioningState#MAJOR})
* @param policies
- * <em>(optional)</em> a list of policy IDs that MUST be applied
+ * <em>(optional)</em> a list of policy IDs that must be applied
* to the newly created document object
* @param addAces
- * <em>(optional)</em> a list of ACEs that MUST be added to the
+ * <em>(optional)</em> a list of ACEs that must be added to the
* newly created document object, either using the ACL from
* <code>folderId</code> if specified, or being applied if no
* <code>folderId</code> is specified
* @param removeAces
- * <em>(optional)</em> a list of ACEs that MUST be removed from
+ * <em>(optional)</em> a list of ACEs that must be removed from
* the newly created document object, either using the ACL from
* <code>folderId</code> if specified, or being ignored if no
* <code>folderId</code> is specified
@@ -89,6 +89,32 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param sourceId
+ * the identifier for the source document
+ * @param properties
+ * the property values that must be applied to the newly created
+ * document object
+ * @param folderId
+ * <em>(optional)</em> if specified, the identifier for the
+ * folder that must be the parent folder for the newly created
+ * document object
+ * @param versioningState
+ * <em>(optional)</em> specifies what the versioning state of the
+ * newly created object must be (default is
+ * {@link VersioningState#MAJOR})
+ * @param policies
+ * <em>(optional)</em> a list of policy IDs that must be applied
+ * to the newly created document object
+ * @param addAces
+ * <em>(optional)</em> a list of ACEs that must be added to the
+ * newly created document object, either using the ACL from
+ * <code>folderId</code> if specified, or being applied if no
+ * <code>folderId</code> is specified
+ * @param removeAces
+ * <em>(optional)</em> a list of ACEs that must be removed from
+ * the newly created document object, either using the ACL from
+ * <code>folderId</code> if specified, or being ignored if no
+ * <code>folderId</code> is specified
*/
String createDocumentFromSource(String repositoryId, String sourceId, Properties properties, String folderId,
VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces,
@@ -100,6 +126,24 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param properties
+ * the property values that must be applied to the newly created
+ * folder object
+ * @param folderId
+ * the identifier for the parent folder
+ * @param policies
+ * <em>(optional)</em> a list of policy IDs that must be applied
+ * to the newly created folder object
+ * @param addAces
+ * <em>(optional)</em> a list of ACEs that must be added to the
+ * newly created folder object, either using the ACL from
+ * <code>folderId</code> if specified, or being applied if no
+ * <code>folderId</code> is specified
+ * @param removeAces
+ * <em>(optional)</em> a list of ACEs that must be removed from
+ * the newly created folder object, either using the ACL from
+ * <code>folderId</code> if specified, or being ignored if no
+ * <code>folderId</code> is specified
*/
String createFolder(String repositoryId, Properties properties, String folderId, List<String> policies,
Acl addAces, Acl removeAces, ExtensionsData extension);
@@ -110,6 +154,22 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param properties
+ * the property values that must be applied to the newly created
+ * relationship object
+ * @param policies
+ * <em>(optional)</em> a list of policy IDs that must be applied
+ * to the newly created relationship object
+ * @param addAces
+ * <em>(optional)</em> a list of ACEs that must be added to the
+ * newly created relationship object, either using the ACL from
+ * <code>folderId</code> if specified, or being applied if no
+ * <code>folderId</code> is specified
+ * @param removeAces
+ * <em>(optional)</em> a list of ACEs that must be removed from
+ * the newly created relationship object, either using the ACL
+ * from <code>folderId</code> if specified, or being ignored if
+ * no <code>folderId</code> is specified
*/
String createRelationship(String repositoryId, Properties properties, List<String> policies, Acl addAces,
Acl removeAces, ExtensionsData extension);
@@ -120,6 +180,26 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param properties
+ * the property values that must be applied to the newly created
+ * policy object
+ * @param folderId
+ * <em>(optional)</em> if specified, the identifier for the
+ * folder that must be the parent folder for the newly created
+ * policy object
+ * @param policies
+ * <em>(optional)</em> a list of policy IDs that must be applied
+ * to the newly created policy object
+ * @param addAces
+ * <em>(optional)</em> a list of ACEs that must be added to the
+ * newly created policy object, either using the ACL from
+ * <code>folderId</code> if specified, or being applied if no
+ * <code>folderId</code> is specified
+ * @param removeAces
+ * <em>(optional)</em> a list of ACEs that must be removed from
+ * the newly created policy object, either using the ACL from
+ * <code>folderId</code> if specified, or being ignored if no
+ * <code>folderId</code> is specified
*/
String createPolicy(String repositoryId, Properties properties, String folderId, List<String> policies,
Acl addAces, Acl removeAces, ExtensionsData extension);
@@ -129,6 +209,8 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
*/
AllowableActions getAllowableActions(String repositoryId, String objectId, ExtensionsData extension);
@@ -137,6 +219,32 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for the object (default is
+ * <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * object participates must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includePolicyIds
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the policy ids for the object (default is
+ * <code>false</code>)
+ * @param includeAcl
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the ACL for the object (default is
+ * <code>false</code>)
*/
ObjectData getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions,
IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds,
@@ -147,6 +255,12 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
*/
Properties getProperties(String repositoryId, String objectId, String filter, ExtensionsData extension);
@@ -156,6 +270,19 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param maxItems
+ * <em>(optional)</em> the maximum number of items to return in a
+ * response (default is repository specific)
+ * @param skipCount
+ * <em>(optional)</em> number of potential results that the
+ * repository must skip/page over before returning any results
+ * (default is 0)
*/
List<RenditionData> getRenditions(String repositoryId, String objectId, String renditionFilter,
BigInteger maxItems, BigInteger skipCount, ExtensionsData extension);
@@ -165,6 +292,32 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param path
+ * the path to the object
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param includeAllowableActions
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the available actions for the object (default is
+ * <code>false</code>)
+ * @param includeRelationships
+ * <em>(optional)</em> indicates what relationships in which the
+ * object participates must be returned (default is
+ * {@link IncludeRelationships#NONE})
+ * @param renditionFilter
+ * <em>(optional)</em> indicates what set of renditions the
+ * repository must return whose kind matches this filter (default
+ * is <code>"cmis:none"</code>)
+ * @param includePolicyIds
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the policy ids for the object (default is
+ * <code>false</code>)
+ * @param includeAcl
+ * <em>(optional)</em> if <code>true</code>, then the repository
+ * must return the ACL for the object (default is
+ * <code>false</code>)
*/
ObjectData getObjectByPath(String repositoryId, String path, String filter, Boolean includeAllowableActions,
IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds,
@@ -177,6 +330,8 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
*/
ContentStream getContentStream(String repositoryId, String objectId, String streamId, BigInteger offset,
BigInteger length, ExtensionsData extension);
@@ -186,6 +341,15 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object. The repository might return a
+ * different/new object id
+ * @param changeToken
+ * <em>(optional)</em> the last change token of this object that
+ * the client received. The repository might return a new change
+ * token (default is <code>null</code>)
+ * @param properties
+ * the updated property values that must be applied to the object
*/
void updateProperties(String repositoryId, Holder<String> objectId, Holder<String> changeToken,
Properties properties, ExtensionsData extension);
@@ -195,6 +359,13 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object. The repository might return a
+ * different/new object id
+ * @param targetFolderId
+ * the identifier for the target folder
+ * @param sourceFolderId
+ * the identifier for the source folder
*/
void moveObject(String repositoryId, Holder<String> objectId, String targetFolderId, String sourceFolderId,
ExtensionsData extension);
@@ -219,6 +390,21 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param folderId
+ * the identifier for the folder
+ * @param allVersions
+ * <em>(optional)</em> If <code>true</code> then delete all
+ * versions of the document, otherwise delete only the document
+ * object specified (default is <code>true</code>)
+ * @param unfileObjects
+ * <em>(optional)</em> defines how the repository must process
+ * file-able child- or descendant-objects (default is
+ * {@link UnfileObject#DELETE})
+ * @param continueOnFailure
+ * <em>(optional)</em> If <code>true</code>, then the repository
+ * should continue attempting to perform this operation even if
+ * deletion of a child- or descendant-object in the specified
+ * folder cannot be deleted (default is <code>false</code>)
*/
FailedToDeleteData deleteTree(String repositoryId, String folderId, Boolean allVersions,
UnfileObject unfileObjects, Boolean continueOnFailure, ExtensionsData extension);
@@ -228,6 +414,22 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object. The repository might return a
+ * different/new object id
+ * @param overwriteFlag
+ * <em>(optional)</em> If <code>true</code>, then the repository
+ * must replace the existing content stream for the object (if
+ * any) with the input content stream. If If <code>false</code>,
+ * then the repository must only set the input content stream for
+ * the object if the object currently does not have a content
+ * stream (default is <code>true</code>)
+ * @param changeToken
+ * <em>(optional)</em> the last change token of this object that
+ * the client received. The repository might return a new change
+ * token (default is <code>null</code>)
+ * @param contentStream
+ * the content stream
*/
void setContentStream(String repositoryId, Holder<String> objectId, Boolean overwriteFlag,
Holder<String> changeToken, ContentStream contentStream, ExtensionsData extension);
@@ -237,6 +439,13 @@ public interface ObjectService {
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object. The repository might return a
+ * different/new object id
+ * @param changeToken
+ * <em>(optional)</em> the last change token of this object that
+ * the client received. The repository might return a new change
+ * token (default is <code>null</code>)
*/
void deleteContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken,
ExtensionsData extension);
Added: incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/package.html
URL: http://svn.apache.org/viewvc/incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/package.html?rev=948062&view=auto
==============================================================================
--- incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/package.html (added)
+++ incubator/chemistry/opencmis/trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/package.html Tue May 25 14:34:33 2010
@@ -0,0 +1,29 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+ -->
+<html>
+<head>
+</head>
+<body>
+OpenCMIS client and server binding services.
+<p>This package provides the CMIS service interfaces for low-level
+client and server implementations.</p>
+</body>
+</html>
\ No newline at end of file