OpenCMIS Client API

Return-Path: X-Original-To: apmail-chemistry-commits-archive@www.apache.org Delivered-To: apmail-chemistry-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id DC71D9E88 for ; Tue, 3 Apr 2012 04:44:55 +0000 (UTC) Received: (qmail 48459 invoked by uid 500); 3 Apr 2012 04:44:55 -0000 Delivered-To: apmail-chemistry-commits-archive@chemistry.apache.org Received: (qmail 48404 invoked by uid 500); 3 Apr 2012 04:44:55 -0000 Mailing-List: contact commits-help@chemistry.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@chemistry.apache.org Delivered-To: mailing list commits@chemistry.apache.org Received: (qmail 48395 invoked by uid 99); 3 Apr 2012 04:44:55 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Apr 2012 04:44:55 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Apr 2012 04:44:33 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 96C6D2388C4E for ; Tue, 3 Apr 2012 04:44:10 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r811227 [3/7] - in /websites/staging/chemistry/trunk/content: ./ java/0.7.0/maven/chemistry-opencmis-client/ java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/ java/0.7.0/maven/chemistry-opencmis-client/chemistry-open... Date: Tue, 03 Apr 2012 04:44:07 -0000 To: commits@chemistry.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120403044410.96C6D2388C4E@eris.apache.org> Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/team-list.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/team-list.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/team-list.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,142 @@ + + + + + + OpenCMIS Client API - Team list + + + + + + + + +

+ + +

+ Last Published: 2012-04-03 +

+ + Version: 0.7.0 +

+ + +

+ +

+ + + +

The Team

A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

Members

The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

Id	Name	Email	URL	Organization	Organization URL	Roles	Ti me Zone	Actual Time (GMT)	Properties
fmui	Florian Müller	-	-	-	-	committer	-	-	-
jenshuebel	Jens Hübel	-	-	-	-	committer	-	-	-
dward	David Ward	-	-	-	-	committer	-	-	-
klevenzs	Stephan Klevenz	sklevenz@apache.org	-	-	-	committer	CET	CET	-
hermesm	Martin Hermes	-	-	-	-	committer	-	-	-
paulgoetz	Paul Goetz	-	-	-	-	committer	-	-	-
dcaruana	David Caruana	-	-	-	-	committer	-	-	-
gabriele	Gabriele Columbro	gabriele@apache.org	-	-	-	release manager	-	-	-
fguillaume	Florent Guillaume	-	-	-	-	committer	-	-	-
sfermigier	Stefane Fermigier	-	-	-	-	committer	-	-	-

Contributors

There are no contributors listed for this project. Please check back again later.

+ + + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/allclasses-frame.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/allclasses-frame.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/allclasses-frame.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,128 @@ + + + + + + All Classes + + + + +

All Classes

+ +

+ + + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/index.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/index.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/index.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,24 @@ + + + + + + OpenCMIS Client API 0.7.0 Reference + + + + + + + + + <body> + <h1>Frame Alert</h1> + <p> + You don't have frames. Go <a href="overview-summary.html">here</a> + </p> + </body> + + + + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvent.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvent.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvent.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,65 @@ + + + + +ChangeEvent xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  import java.util.List;
+22  import java.util.Map;
+23  
+24  import org.apache.chemistry.opencmis.commons.data.Acl;
+25  import org.apache.chemistry.opencmis.commons.data.ChangeEventInfo;
+26  
+27  /**
+28   * Change Event from the change log.
+29   */
+30  public interface ChangeEvent extends ChangeEventInfo {
+31  
+32      /**
+33       * Gets the id of the object.
+34       */
+35      String getObjectId();
+36  
+37      /**
+38       * Returns the properties.
+39       */
+40      Map<String, List<?>> getProperties();
+41  
+42      /**
+43       * Returns the policy ids.
+44       */
+45      List<String> getPolicyIds();
+46  
+47      /**
+48       * Returns the ACL.
+49       */
+50      Acl getAcl();
+51  }
+

+ + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvents.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvents.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/ChangeEvents.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,46 @@ + + + + +ChangeEvents xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  import java.util.List;
+22  
+23  public interface ChangeEvents {
+24  
+25      String getLatestChangeLogToken();
+26  
+27      List<ChangeEvent> getChangeEvents();
+28  
+29      boolean getHasMoreItems();
+30      
+31      long getTotalNumItems();
+32  }
+

+ + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObject.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObject.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObject.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,185 @@ + + + + +CmisObject xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  import java.util.List;
+22  import java.util.Map;
+23  
+24  import org.apache.chemistry.opencmis.commons.data.Ace;
+25  import org.apache.chemistry.opencmis.commons.data.Acl;
+26  import org.apache.chemistry.opencmis.commons.data.AllowableActions;
+27  import org.apache.chemistry.opencmis.commons.data.CmisExtensionElement;
+28  import org.apache.chemistry.opencmis.commons.enums.AclPropagation;
+29  import org.apache.chemistry.opencmis.commons.enums.ExtensionLevel;
+30  
+31  /**
+32   * Base CMIS object.
+33   * <p>
+34   * See CMIS Domain Model - section 2.1.2.
+35   */
+36  public interface CmisObject extends ObjectId, CmisObjectProperties {
+37  
+38      // object
+39  
+40      /**
+41       * Returns the allowable actions if they have been fetched for this object.
+42       */
+43      AllowableActions getAllowableActions();
+44  
+45      /**
+46       * Returns the relationships if they have been fetched for this object.
+47       */
+48      List<Relationship> getRelationships();
+49  
+50      /**
+51       * Returns the ACL if it has been fetched for this object.
+52       */
+53      Acl getAcl();
+54  
+55      // object service
+56  
+57      /**
+58       * Deletes this object.
+59       * 
+60       * @param allVersions
+61       *            if this object is a document this parameter defines if just
+62       *            this version or all versions should be deleted
+63       */
+64      void delete(boolean allVersions);
+65  
+66      /**
+67       * Updates the properties that are provided.
+68       * 
+69       * @param properties
+70       *            the properties to update
+71       * 
+72       * @return the updated object (a repository might have created a new object)
+73       */
+74      CmisObject updateProperties(Map<String, ?> properties);
+75  
+76      /**
+77       * Updates the properties that are provided.
+78       * 
+79       * @param properties
+80       *            the properties to update
+81       * @param refresh
+82       *            indicates if the object should be refresh after the update
+83       * 
+84       * @return the object id of the updated object (a repository might have
+85       *         created a new object)
+86       * 
+87       */
+88      ObjectId updateProperties(Map<String, ?> properties, boolean refresh);
+89  
+90      // renditions
+91  
+92      /**
+93       * Returns the renditions if they have been fetched for this object.
+94       */
+95      List<Rendition> getRenditions();
+96  
+97      // policy service
+98  
+99      /**
+100      * Applies policies to this object.
+101      */
+102     void applyPolicy(ObjectId... policyIds);
+103 
+104     /**
+105      * Remove policies from this object.
+106      */
+107     void removePolicy(ObjectId... policyIds);
+108 
+109     /**
+110      * Returns the applied policies if they have been fetched for this object.
+111      */
+112     List<Policy> getPolicies();
+113 
+114     // ACL service
+115 
+116     /**
+117      * Adds and removes ACEs to the object.
+118      * 
+119      * @return the new ACL of this object
+120      */
+121     Acl applyAcl(List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation);
+122 
+123     /**
+124      * Adds ACEs to the object.
+125      */
+126     Acl addAcl(List<Ace> addAces, AclPropagation aclPropagation);
+127 
+128     /**
+129      * Removes ACEs to the object.
+130      */
+131     Acl removeAcl(List<Ace> removeAces, AclPropagation aclPropagation);
+132 
+133     // extensions
+134 
+135     /**
+136      * Returns the extensions for the given level.
+137      */
+138     List<CmisExtensionElement> getExtensions(ExtensionLevel level);
+139 
+140     // adapters
+141 
+142     /**
+143      * Returns an adapter based on the given interface.
+144      */
+145     <T> T getAdapter(Class<T> adapterInterface);
+146 
+147     /**
+148      * Returns a transient object adapter.
+149      * 
+150      * @see TransientCmisObject
+151      */
+152     TransientCmisObject getTransientObject();
+153 
+154     // session handling
+155 
+156     /**
+157      * Returns the timestamp (in milliseconds) of the last refresh.
+158      */
+159     long getRefreshTimestamp();
+160 
+161     /**
+162      * Reloads the data from the repository.
+163      */
+164     void refresh();
+165 
+166     /**
+167      * Reloads the data from the repository if the last refresh did not occur
+168      * within <code>durationInMillis</code>.
+169      */
+170     void refreshIfOld(long durationInMillis);
+171 }
+

+ + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,127 @@ + + + + +CmisObjectProperties xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  import java.util.GregorianCalendar;
+22  import java.util.List;
+23  
+24  import org.apache.chemistry.opencmis.commons.enums.BaseTypeId;
+25  
+26  /**
+27   * Accessors to CMIS object properties.
+28   * <p>
+29   * A property might not be available because either the repository didn't
+30   * provide it or a property filter was used to retrieve this object.
+31   * <p>
+32   * The property values represent a snapshot of the object when it was loaded.
+33   * The objects and its properties can be out-of-date if the object has been
+34   * modified in the repository.
+35   * <p>
+36   * Implementations of this interface might alter property values without
+37   * updating the object in the repository. In this case, the values returned by
+38   * these accessors don't reflect the state of the object in the repository.
+39   */
+40  public interface CmisObjectProperties {
+41  
+42      /**
+43       * Returns a list of all available CMIS properties.
+44       */
+45      List<Property<?>> getProperties();
+46  
+47      /**
+48       * Returns the requested property. If the property is not available,
+49       * <code>null</code> is returned.
+50       */
+51      <T> Property<T> getProperty(String id);
+52  
+53      /**
+54       * Returns the value of the requested property. If the property is not
+55       * available, <code>null</code> is returned.
+56       */
+57      <T> T getPropertyValue(String id);
+58  
+59      // convenience accessors
+60  
+61      /**
+62       * Returns the name of this CMIS object (CMIS property
+63       * <code>cmis:name</code>).
+64       */
+65      String getName();
+66  
+67      /**
+68       * Returns the user who created this CMIS object (CMIS property
+69       * <code>cmis:createdBy</code>).
+70       */
+71      String getCreatedBy();
+72  
+73      /**
+74       * Returns the timestamp when this CMIS object has been created (CMIS
+75       * property <code>cmis:creationDate</code>).
+76       */
+77      GregorianCalendar getCreationDate();
+78  
+79      /**
+80       * Returns the user who modified this CMIS object (CMIS property
+81       * <code>cmis:lastModifiedBy</code>).
+82       */
+83      String getLastModifiedBy();
+84  
+85      /**
+86       * Returns the timestamp when this CMIS object has been modified (CMIS
+87       * property <code>cmis:lastModificationDate</code>).
+88       */
+89      GregorianCalendar getLastModificationDate();
+90  
+91      /**
+92       * Returns the id of the base type of this CMIS object (CMIS property
+93       * <code>cmis:baseTypeId</code>).
+94       */
+95      BaseTypeId getBaseTypeId();
+96  
+97      /**
+98       * Returns the base type of this CMIS object (object type identified by
+99       * <code>cmis:baseTypeId</code>).
+100      */
+101     ObjectType getBaseType();
+102 
+103     /**
+104      * Returns the type of this CMIS object (object type identified by
+105      * <code>cmis:objectTypeId</code>).
+106      */
+107     ObjectType getType();
+108 
+109     /**
+110      * Returns the change token (CMIS property <code>cmis:changeToken</code>).
+111      */
+112     String getChangeToken();
+113 }
+

+ + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/Document.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/Document.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/Document.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,176 @@ + + + + +Document xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  import java.util.List;
+22  import java.util.Map;
+23  
+24  import org.apache.chemistry.opencmis.commons.data.Ace;
+25  import org.apache.chemistry.opencmis.commons.data.ContentStream;
+26  import org.apache.chemistry.opencmis.commons.enums.VersioningState;
+27  
+28  /**
+29   * CMIS Document.
+30   * <p>
+31   * Domain Model 2.4
+32   */
+33  public interface Document extends FileableCmisObject, DocumentProperties {
+34  
+35      TransientDocument getTransientDocument();
+36  
+37      // object service
+38  
+39      /**
+40       * Deletes this document and all its versions.
+41       */
+42      void deleteAllVersions();
+43  
+44      /**
+45       * Retrieves the content stream of this document.
+46       * 
+47       * @return the content stream, or {@code null}
+48       */
+49      ContentStream getContentStream();
+50  
+51      /**
+52       * Retrieves the content stream that is associated with the given stream id.
+53       * This is usually a rendition of the document.
+54       * 
+55       * @return the content stream, or {@code null}
+56       */
+57      ContentStream getContentStream(String streamId);
+58  
+59      /**
+60       * Sets a new content stream for the document.
+61       */
+62      Document setContentStream(ContentStream contentStream, boolean overwrite);
+63  
+64      /**
+65       * Sets a new content stream for the document.
+66       */
+67      ObjectId setContentStream(ContentStream contentStream, boolean overwrite, boolean refresh);
+68  
+69      /**
+70       * Removes the current content stream from the document.
+71       */
+72      Document deleteContentStream();
+73  
+74      /**
+75       * Removes the current content stream from the document.
+76       */
+77      ObjectId deleteContentStream(boolean refresh);
+78  
+79      // versioning service
+80  
+81      /**
+82       * Checks out the document and returns the object id of the PWC (private
+83       * working copy).
+84       * 
+85       * @return PWC id
+86       */
+87      ObjectId checkOut(); // returns the PWC id
+88  
+89      /**
+90       * If this is a PWC (private working copy) the check out will be reversed.
+91       * If this is not a PWC it an exception will be thrown.
+92       */
+93      void cancelCheckOut();
+94  
+95      /**
+96       * If this is a PWC (private working copy) it performs a check in. If this
+97       * is not a PWC it an exception will be thrown.
+98       * 
+99       * @return new document id
+100      */
+101     ObjectId checkIn(boolean major, Map<String, ?> properties, ContentStream contentStream, String checkinComment,
+102             List<Policy> policies, List<Ace> addAces, List<Ace> removeAces);
+103 
+104     /**
+105      * If this is a PWC (private working copy) it performs a check in. If this
+106      * is not a PWC it an exception will be thrown.
+107      * 
+108      * @return new document id
+109      */
+110     ObjectId checkIn(boolean major, Map<String, ?> properties, ContentStream contentStream, String checkinComment);
+111 
+112     /**
+113      * Fetches the latest major or minor version of this document.
+114      * 
+115      * @param major
+116      *            if <code>true</code> the latest major version will be
+117      *            returned, otherwise the very last version will be returned
+118      * 
+119      * @return the latest document object
+120      */
+121     Document getObjectOfLatestVersion(boolean major);
+122 
+123     /**
+124      * Fetches the latest major or minor version of this document using the
+125      * given {@link OperationContext}.
+126      * 
+127      * @param major
+128      *            if <code>true</code> the latest major version will be
+129      *            returned, otherwise the very last version will be returned
+130      * 
+131      * @return the latest document object
+132      */
+133     Document getObjectOfLatestVersion(boolean major, OperationContext context);
+134 
+135     /**
+136      * Fetches all versions of this document.
+137      */
+138     List<Document> getAllVersions();
+139 
+140     /**
+141      * Fetches all versions of this document using the given
+142      * {@link OperationContext}.
+143      */
+144     List<Document> getAllVersions(OperationContext context);
+145 
+146     /**
+147      * Creates a copy of this document, including content.
+148      * 
+149      * @return the new document object
+150      */
+151     Document copy(ObjectId targetFolderId);
+152 
+153     /**
+154      * Creates a copy of this document, including content.
+155      * 
+156      * @return the new document object or {@code null} if the parameter
+157      *         {@code context} was set to {@code null}
+158      */
+159     Document copy(ObjectId targetFolderId, Map<String, ?> properties, VersioningState versioningState,
+160             List<Policy> policies, List<Ace> addACEs, List<Ace> removeACEs, OperationContext context);
+161 
+162 }
+

+ + Added: websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/DocumentProperties.html ============================================================================== --- websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/DocumentProperties.html (added) +++ websites/staging/chemistry/trunk/content/java/0.7.0/maven/chemistry-opencmis-client/chemistry-opencmis-client-api/xref/org/apache/chemistry/opencmis/client/api/DocumentProperties.html Tue Apr 3 04:44:05 2012 @@ -0,0 +1,127 @@ + + + + +DocumentProperties xref + + + +

+
+1   /*
+2    * Licensed to the Apache Software Foundation (ASF) under one
+3    * or more contributor license agreements.  See the NOTICE file
+4    * distributed with this work for additional information
+5    * regarding copyright ownership.  The ASF licenses this file
+6    * to you under the Apache License, Version 2.0 (the
+7    * "License"); you may not use this file except in compliance
+8    * with the License.  You may obtain a copy of the License at
+9    *
+10   * http://www.apache.org/licenses/LICENSE-2.0
+11   *
+12   * Unless required by applicable law or agreed to in writing,
+13   * software distributed under the License is distributed on an
+14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+15   * KIND, either express or implied.  See the License for the
+16   * specific language governing permissions and limitations
+17   * under the License.
+18   */
+19  package org.apache.chemistry.opencmis.client.api;
+20  
+21  /**
+22   * Accessors to CMIS document properties.
+23   *
+24   * @see CmisObjectProperties
+25   */
+26  public interface DocumentProperties {
+27  
+28      /**
+29       * Returns <code>true</code> if this CMIS object is immutable (CMIS property
+30       * <code>cmis:isImmutable</code>).
+31       */
+32      Boolean isImmutable();
+33  
+34      /**
+35       * Returns if this CMIS object is the latest version (CMIS property
+36       * <code>cmis:isLatestVersion</code>).
+37       */
+38      Boolean isLatestVersion();
+39  
+40      /**
+41       * Returns
+42       * <code>true<code> if this CMIS object is the latest version (CMIS property
+43       * <code>cmis:isMajorVersion</code>).
+44       */
+45      Boolean isMajorVersion();
+46  
+47      /**
+48       * Returns
+49       * <code>true</code> if this CMIS object is the latest major version (CMIS property
+50       * <code>cmis:isLatestMajorVersion</code>).
+51       */
+52      Boolean isLatestMajorVersion();
+53  
+54      /**
+55       * Returns the version label (CMIS property <code>cmis:versionLabel</code>).
+56       */
+57      String getVersionLabel();
+58  
+59      /**
+60       * Returns the version series id (CMIS property
+61       * <code>cmis:versionSeriesId</code>).
+62       */
+63      String getVersionSeriesId();
+64  
+65      /**
+66       * Returns
+67       * <code>true</code> if this version series is checked out (CMIS property
+68       * <code>cmis:isVersionSeriesCheckedOut</code>).
+69       */
+70      Boolean isVersionSeriesCheckedOut();
+71  
+72      /**
+73       * Returns the user who checked out this version series (CMIS property
+74       * <code>cmis:versionSeriesCheckedOutBy</code>).
+75       */
+76      String getVersionSeriesCheckedOutBy();
+77  
+78      /**
+79       * Returns the PWC id of this version series (CMIS property
+80       * <code>cmis:versionSeriesCheckedOutId</code>).
+81       */
+82      String getVersionSeriesCheckedOutId();
+83  
+84      /**
+85       * Returns the checkin comment (CMIS property
+86       * <code>cmis:checkinComment</code>).
+87       */
+88      String getCheckinComment();
+89  
+90      /**
+91       * Returns the content stream length or -1 if the document has no content
+92       * (CMIS property <code>cmis:contentStreamLength</code>).
+93       */
+94      long getContentStreamLength();
+95  
+96      /**
+97       * Returns the content stream MIME type or <code>null</code> if the document
+98       * has no content (CMIS property <code>cmis:contentStreamMimeType</code>).
+99       */
+100     String getContentStreamMimeType();
+101 
+102     /**
+103      * Returns the content stream filename or <code>null</code> if the document
+104      * has no content (CMIS property <code>cmis:contentStreamFileName</code>).
+105      */
+106     String getContentStreamFileName();
+107 
+108     /**
+109      * Returns the content stream id or <code>null</code> if the document has no
+110      * content (CMIS property <code>cmis:contentStreamId</code>).
+111      */
+112     String getContentStreamId();
+113 }
+

+ +

Parent Project

Project Documentation

Chemistry

The Team

Members

Contributors

All Classes