| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Thu Jun 20 13:09:11 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Document (Apache Chemistry OpenCMIS 0.9.0)</title> |
| <meta name="date" content="2013-06-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Document (Apache Chemistry OpenCMIS 0.9.0)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Document.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/client/api/Document.html" target="_top">Frames</a></li> |
| <li><a href="Document.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.chemistry.opencmis.client.api</div> |
| <h2 title="Interface Document" class="title">Interface Document</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html" title="interface in org.apache.chemistry.opencmis.client.api">CmisObject</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html" title="interface in org.apache.chemistry.opencmis.client.api">CmisObjectProperties</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html" title="interface in org.apache.chemistry.opencmis.client.api">DocumentProperties</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html" title="interface in org.apache.chemistry.opencmis.client.api">FileableCmisObject</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Document</span> |
| extends <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html" title="interface in org.apache.chemistry.opencmis.client.api">FileableCmisObject</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html" title="interface in org.apache.chemistry.opencmis.client.api">DocumentProperties</a></pre> |
| <div class="block">CMIS document interface.</div> |
| <dl><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#appendContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean)">appendContentStream</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean isLastChunk)</code> |
| <div class="block">Appends a content stream to the content stream of the document and |
| refreshes this object afterwards.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#appendContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean, boolean)">appendContentStream</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean isLastChunk, |
| boolean refresh)</code> |
| <div class="block">Appends a content stream to the content stream of the document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#cancelCheckOut()">cancelCheckOut</a></strong>()</code> |
| <div class="block">If this is a PWC (private working copy) the check out will be reversed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#checkIn(boolean, java.util.Map, org.apache.chemistry.opencmis.commons.data.ContentStream, java.lang.String)">checkIn</a></strong>(boolean major, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> checkinComment)</code> |
| <div class="block">If this is a PWC (private working copy) it performs a check in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#checkIn(boolean, java.util.Map, org.apache.chemistry.opencmis.commons.data.ContentStream, java.lang.String, java.util.List, java.util.List, java.util.List)">checkIn</a></strong>(boolean major, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> checkinComment, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api">Policy</a>> policies, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> addAces, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> removeAces)</code> |
| <div class="block">If this is a PWC (private working copy) it performs a check in.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#checkOut()">checkOut</a></strong>()</code> |
| <div class="block">Checks out the document and returns the object id of the PWC (private |
| working copy).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#copy(org.apache.chemistry.opencmis.client.api.ObjectId)">copy</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> targetFolderId)</code> |
| <div class="block">Creates a copy of this document, including content.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#copy(org.apache.chemistry.opencmis.client.api.ObjectId, java.util.Map, org.apache.chemistry.opencmis.commons.enums.VersioningState, java.util.List, java.util.List, java.util.List, org.apache.chemistry.opencmis.client.api.OperationContext)">copy</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> targetFolderId, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/VersioningState.html" title="enum in org.apache.chemistry.opencmis.commons.enums">VersioningState</a> versioningState, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api">Policy</a>> policies, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> addACEs, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> removeACEs, |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</code> |
| <div class="block">Creates a copy of this document, including content.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteAllVersions()">deleteAllVersions</a></strong>()</code> |
| <div class="block">Deletes this document and all its versions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteContentStream()">deleteContentStream</a></strong>()</code> |
| <div class="block">Removes the current content stream from the document and refreshes this |
| object afterwards.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteContentStream(boolean)">deleteContentStream</a></strong>(boolean refresh)</code> |
| <div class="block">Removes the current content stream from the document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getAllVersions()">getAllVersions</a></strong>()</code> |
| <div class="block">Fetches all versions of this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getAllVersions(org.apache.chemistry.opencmis.client.api.OperationContext)">getAllVersions</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</code> |
| <div class="block">Fetches all versions of this document using the given |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api"><code>OperationContext</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream()">getContentStream</a></strong>()</code> |
| <div class="block">Retrieves the content stream of this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream(java.math.BigInteger, java.math.BigInteger)">getContentStream</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> offset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> length)</code> |
| <div class="block">Retrieves the content stream of this document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream(java.lang.String)">getContentStream</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">Retrieves the content stream that is associated with the given stream id.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream(java.lang.String, java.math.BigInteger, java.math.BigInteger)">getContentStream</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> offset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> length)</code> |
| <div class="block">Retrieves the content stream that is associated with the given stream id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getObjectOfLatestVersion(boolean)">getObjectOfLatestVersion</a></strong>(boolean major)</code> |
| <div class="block">Fetches the latest major or minor version of this document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getObjectOfLatestVersion(boolean, org.apache.chemistry.opencmis.client.api.OperationContext)">getObjectOfLatestVersion</a></strong>(boolean major, |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</code> |
| <div class="block">Fetches the latest major or minor version of this document using the |
| given <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api"><code>OperationContext</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/TransientDocument.html" title="interface in org.apache.chemistry.opencmis.client.api">TransientDocument</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getTransientDocument()">getTransientDocument</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>Support for transient objects will be removed in the future.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#setContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean)">setContentStream</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean overwrite)</code> |
| <div class="block">Sets a new content stream for the document and refreshes this object |
| afterwards.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#setContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean, boolean)">setContentStream</a></strong>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean overwrite, |
| boolean refresh)</code> |
| <div class="block">Sets a new content stream for the document.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.client.api.FileableCmisObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.chemistry.opencmis.client.api.<a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html" title="interface in org.apache.chemistry.opencmis.client.api">FileableCmisObject</a></h3> |
| <code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#addToFolder(org.apache.chemistry.opencmis.client.api.ObjectId, boolean)">addToFolder</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#getParents()">getParents</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#getParents(org.apache.chemistry.opencmis.client.api.OperationContext)">getParents</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#getPaths()">getPaths</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#move(org.apache.chemistry.opencmis.client.api.ObjectId, org.apache.chemistry.opencmis.client.api.ObjectId)">move</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#move(org.apache.chemistry.opencmis.client.api.ObjectId, org.apache.chemistry.opencmis.client.api.ObjectId, org.apache.chemistry.opencmis.client.api.OperationContext)">move</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/FileableCmisObject.html#removeFromFolder(org.apache.chemistry.opencmis.client.api.ObjectId)">removeFromFolder</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.client.api.CmisObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.chemistry.opencmis.client.api.<a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html" title="interface in org.apache.chemistry.opencmis.client.api">CmisObject</a></h3> |
| <code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#addAcl(java.util.List, org.apache.chemistry.opencmis.commons.enums.AclPropagation)">addAcl</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#applyAcl(java.util.List, java.util.List, org.apache.chemistry.opencmis.commons.enums.AclPropagation)">applyAcl</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#applyPolicy(org.apache.chemistry.opencmis.client.api.ObjectId...)">applyPolicy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#delete()">delete</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#delete(boolean)">delete</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getAcl()">getAcl</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getAllowableActions()">getAllowableActions</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getExtensions(org.apache.chemistry.opencmis.commons.enums.ExtensionLevel)">getExtensions</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getPolicies()">getPolicies</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getRefreshTimestamp()">getRefreshTimestamp</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getRelationships()">getRelationships</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getRenditions()">getRenditions</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getTransientObject()">getTransientObject</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#refresh()">refresh</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#refreshIfOld(long)">refreshIfOld</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#removeAcl(java.util.List, org.apache.chemistry.opencmis.commons.enums.AclPropagation)">removeAcl</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#removePolicy(org.apache.chemistry.opencmis.client.api.ObjectId...)">removePolicy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#setAcl(java.util.List)">setAcl</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#updateProperties(java.util.Map)">updateProperties</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#updateProperties(java.util.Map, boolean)">updateProperties</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.client.api.ObjectId"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.chemistry.opencmis.client.api.<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a></h3> |
| <code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html#getId()">getId</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.client.api.CmisObjectProperties"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.chemistry.opencmis.client.api.<a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html" title="interface in org.apache.chemistry.opencmis.client.api">CmisObjectProperties</a></h3> |
| <code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#findObjectType(java.lang.String)">findObjectType</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getBaseType()">getBaseType</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getBaseTypeId()">getBaseTypeId</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getChangeToken()">getChangeToken</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getCreatedBy()">getCreatedBy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getCreationDate()">getCreationDate</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getDescription()">getDescription</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getLastModificationDate()">getLastModificationDate</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getLastModifiedBy()">getLastModifiedBy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getName()">getName</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getProperties()">getProperties</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getProperty(java.lang.String)">getProperty</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getSecondaryTypes()">getSecondaryTypes</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html#getType()">getType</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.chemistry.opencmis.client.api.DocumentProperties"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.chemistry.opencmis.client.api.<a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html" title="interface in org.apache.chemistry.opencmis.client.api">DocumentProperties</a></h3> |
| <code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getCheckinComment()">getCheckinComment</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getContentStreamFileName()">getContentStreamFileName</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getContentStreamId()">getContentStreamId</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getContentStreamLength()">getContentStreamLength</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getContentStreamMimeType()">getContentStreamMimeType</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getVersionLabel()">getVersionLabel</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getVersionSeriesCheckedOutBy()">getVersionSeriesCheckedOutBy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getVersionSeriesCheckedOutId()">getVersionSeriesCheckedOutId</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#getVersionSeriesId()">getVersionSeriesId</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isImmutable()">isImmutable</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isLatestMajorVersion()">isLatestMajorVersion</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isLatestVersion()">isLatestVersion</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isMajorVersion()">isMajorVersion</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isPrivateWorkingCopy()">isPrivateWorkingCopy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isVersionSeriesCheckedOut()">isVersionSeriesCheckedOut</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getTransientDocument()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransientDocument</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/TransientDocument.html" title="interface in org.apache.chemistry.opencmis.client.api">TransientDocument</a> getTransientDocument()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>Support for transient objects will be removed in the future.</i></div> |
| </li> |
| </ul> |
| <a name="deleteAllVersions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAllVersions</h4> |
| <pre>void deleteAllVersions()</pre> |
| <div class="block">Deletes this document and all its versions.</div> |
| <dl><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> getContentStream()</pre> |
| <div class="block">Retrieves the content stream of this document.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the content stream, or <code>null</code> if the document has no |
| content</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentStream(java.math.BigInteger, java.math.BigInteger)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> getContentStream(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> offset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> length)</pre> |
| <div class="block">Retrieves the content stream of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - the offset of the stream or <code>null</code> to read the |
| stream from the beginning</dd><dd><code>length</code> - the maximum length of the stream or <code>null</code> to read |
| to the end of the stream</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the content stream, or <code>null</code> if the document has no |
| content</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentStream(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> getContentStream(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block">Retrieves the content stream that is associated with the given stream id. |
| This is usually a rendition of the document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamId</code> - the stream id</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the content stream, or <code>null</code> if no content is |
| associated with this stream id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getContentStream(java.lang.String, java.math.BigInteger, java.math.BigInteger)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> getContentStream(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> offset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> length)</pre> |
| <div class="block">Retrieves the content stream that is associated with the given stream id. |
| This is usually a rendition of the document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamId</code> - the stream id</dd><dd><code>offset</code> - the offset of the stream or <code>null</code> to read the |
| stream from the beginning</dd><dd><code>length</code> - the maximum length of the stream or <code>null</code> to read |
| to the end of the stream</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the content stream, or <code>null</code> if no content is |
| associated with this stream id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> setContentStream(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean overwrite)</pre> |
| <div class="block">Sets a new content stream for the document and refreshes this object |
| afterwards. If the repository created a new version, this new document is |
| returned. Otherwise the current document is returned. |
| <p> |
| The stream in <code>contentStream</code> is consumed but not closed by |
| this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentStream</code> - the content stream</dd><dd><code>overwrite</code> - if this parameter is set to <code>false</code> and the |
| document already has content, the repository throws a |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/exceptions/CmisContentAlreadyExistsException.html" title="class in org.apache.chemistry.opencmis.commons.exceptions"><code>CmisContentAlreadyExistsException</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the updated document, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectFactory.html#createContentStream(java.lang.String, long, java.lang.String, java.io.InputStream)"><code>ObjectFactory.createContentStream(String, long, String, |
| java.io.InputStream)</code></a></dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> setContentStream(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean overwrite, |
| boolean refresh)</pre> |
| <div class="block">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. |
| <p> |
| The stream in <code>contentStream</code> is consumed but not closed by |
| this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentStream</code> - the content stream</dd><dd><code>overwrite</code> - if this parameter is set to <code>false</code> and the |
| document already has content, the repository throws a |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/exceptions/CmisContentAlreadyExistsException.html" title="class in org.apache.chemistry.opencmis.commons.exceptions"><code>CmisContentAlreadyExistsException</code></a></dd><dd><code>refresh</code> - if this parameter is set to <code>true</code>, this object |
| will be refreshed after the new content has been set</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the updated object id, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectFactory.html#createContentStream(java.lang.String, long, java.lang.String, java.io.InputStream)"><code>ObjectFactory.createContentStream(String, long, String, |
| java.io.InputStream)</code></a></dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="appendContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> appendContentStream(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean isLastChunk)</pre> |
| <div class="block">Appends a content stream to the content stream of the document and |
| refreshes this object afterwards. If the repository created a new |
| version, this new document is returned. Otherwise the current document is |
| returned. |
| <p> |
| The stream in <code>contentStream</code> is consumed but not closed by |
| this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentStream</code> - the content stream</dd><dd><code>isLastChunk</code> - indicates if this stream is the last chunk of the content</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the updated document, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectFactory.html#createContentStream(java.lang.String, long, java.lang.String, java.io.InputStream)"><code>ObjectFactory.createContentStream(String, long, String, |
| java.io.InputStream)</code></a></dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="appendContentStream(org.apache.chemistry.opencmis.commons.data.ContentStream, boolean, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> appendContentStream(<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| boolean isLastChunk, |
| boolean refresh)</pre> |
| <div class="block">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. |
| <p> |
| The stream in <code>contentStream</code> is consumed but not closed by |
| this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentStream</code> - the content stream</dd><dd><code>isLastChunk</code> - indicates if this stream is the last chunk of the content</dd><dd><code>refresh</code> - if this parameter is set to <code>true</code>, this object |
| will be refreshed after the content stream has been appended</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the updated object id, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="deleteContentStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> deleteContentStream()</pre> |
| <div class="block">Removes the current content stream from the document and refreshes this |
| object afterwards. If the repository created a new version, this new |
| document is returned. Otherwise the current document is returned.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the updated document, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="deleteContentStream(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteContentStream</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> deleteContentStream(boolean refresh)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>refresh</code> - if this parameter is set to <code>true</code>, this object |
| will be refreshed after the content stream has been deleted</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the updated document, or <code>null</code> if the repository did |
| not return an object id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="checkOut()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkOut</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> checkOut()</pre> |
| <div class="block">Checks out the document and returns the object id of the PWC (private |
| working copy).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>PWC object id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="cancelCheckOut()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelCheckOut</h4> |
| <pre>void cancelCheckOut()</pre> |
| <div class="block">If this is a PWC (private working copy) the check out will be reversed. |
| If this is not a PWC it an exception will be thrown.</div> |
| <dl><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="checkIn(boolean, java.util.Map, org.apache.chemistry.opencmis.commons.data.ContentStream, java.lang.String, java.util.List, java.util.List, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkIn</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> checkIn(boolean major, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> checkinComment, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api">Policy</a>> policies, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> addAces, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> removeAces)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>new document id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="checkIn(boolean, java.util.Map, org.apache.chemistry.opencmis.commons.data.ContentStream, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkIn</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> checkIn(boolean major, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/data/ContentStream.html" title="interface in org.apache.chemistry.opencmis.commons.data">ContentStream</a> contentStream, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> checkinComment)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>new document id</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getObjectOfLatestVersion(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectOfLatestVersion</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> getObjectOfLatestVersion(boolean major)</pre> |
| <div class="block">Fetches the latest major or minor version of this document.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>major</code> - if <code>true</code> the latest major version will be |
| returned, otherwise the very last version will be returned</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the latest document object</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getObjectOfLatestVersion(boolean, org.apache.chemistry.opencmis.client.api.OperationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectOfLatestVersion</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> getObjectOfLatestVersion(boolean major, |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</pre> |
| <div class="block">Fetches the latest major or minor version of this document using the |
| given <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api"><code>OperationContext</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>major</code> - if <code>true</code> the latest major version will be |
| returned, otherwise the very last version will be returned</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the latest document object</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getAllVersions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllVersions</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a>> getAllVersions()</pre> |
| <div class="block">Fetches all versions of this document.</div> |
| <dl><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getAllVersions(org.apache.chemistry.opencmis.client.api.OperationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllVersions</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a>> getAllVersions(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</pre> |
| <div class="block">Fetches all versions of this document using the given |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api"><code>OperationContext</code></a>.</div> |
| <dl><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="copy(org.apache.chemistry.opencmis.client.api.ObjectId)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> copy(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> targetFolderId)</pre> |
| <div class="block">Creates a copy of this document, including content.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the new document object</dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="copy(org.apache.chemistry.opencmis.client.api.ObjectId, java.util.Map, org.apache.chemistry.opencmis.commons.enums.VersioningState, java.util.List, java.util.List, java.util.List, org.apache.chemistry.opencmis.client.api.OperationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html" title="interface in org.apache.chemistry.opencmis.client.api">Document</a> copy(<a href="../../../../../../org/apache/chemistry/opencmis/client/api/ObjectId.html" title="interface in org.apache.chemistry.opencmis.client.api">ObjectId</a> targetFolderId, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties, |
| <a href="../../../../../../org/apache/chemistry/opencmis/commons/enums/VersioningState.html" title="enum in org.apache.chemistry.opencmis.commons.enums">VersioningState</a> versioningState, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/client/api/Policy.html" title="interface in org.apache.chemistry.opencmis.client.api">Policy</a>> policies, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> addACEs, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/chemistry/opencmis/commons/data/Ace.html" title="interface in org.apache.chemistry.opencmis.commons.data">Ace</a>> removeACEs, |
| <a href="../../../../../../org/apache/chemistry/opencmis/client/api/OperationContext.html" title="interface in org.apache.chemistry.opencmis.client.api">OperationContext</a> context)</pre> |
| <div class="block">Creates a copy of this document, including content.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the new document object or <code>null</code> if the parameter |
| <code>context</code> was set to <code>null</code></dd><dt><span class="strong">CMIS:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Document.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObjectProperties.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html" title="interface in org.apache.chemistry.opencmis.client.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/client/api/Document.html" target="_top">Frames</a></li> |
| <li><a href="Document.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
