| <!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 (1.8.0_121) on Fri Mar 31 15:41:38 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Document (Apache Chemistry OpenCMIS 1.1.0)</title> |
| <meta name="date" content="2017-03-31"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Document (Apache Chemistry OpenCMIS 1.1.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="typeNameLink">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="typeNameLink">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="typeNameLabel">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="simpleTagLabel">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#appendContentStream-org.apache.chemistry.opencmis.commons.data.ContentStream-boolean-">appendContentStream</a></span>(<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 id="i1" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#appendContentStream-org.apache.chemistry.opencmis.commons.data.ContentStream-boolean-boolean-">appendContentStream</a></span>(<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 id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#cancelCheckOut--">cancelCheckOut</a></span>()</code> |
| <div class="block">If this is a PWC (private working copy) the check out will be reversed.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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><span class="memberNameLink"><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></span>(boolean major, |
| <a href="http://docs.oracle.com/javase/7/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/7/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/7/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 id="i4" 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><span class="memberNameLink"><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></span>(boolean major, |
| <a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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 id="i5" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#checkOut--">checkOut</a></span>()</code> |
| <div class="block">Checks out the document and returns the object ID of the PWC (private |
| working copy).</div> |
| </td> |
| </tr> |
| <tr id="i6" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#copy-org.apache.chemistry.opencmis.client.api.ObjectId-">copy</a></span>(<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 id="i7" 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><span class="memberNameLink"><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></span>(<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/7/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/7/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/7/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/7/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/7/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 id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#createAppendOutputStream--">createAppendOutputStream</a></span>()</code> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to append |
| content the current content of the document.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#createAppendOutputStream-int-">createAppendOutputStream</a></span>(int bufferSize)</code> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to append |
| content the current content of the document.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#createOverwriteOutputStream-java.lang.String-java.lang.String-">createOverwriteOutputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType)</code> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to |
| overwrite the current content of the document.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#createOverwriteOutputStream-java.lang.String-java.lang.String-int-">createOverwriteOutputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType, |
| int bufferSize)</code> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to |
| overwrite the current content of the document.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteAllVersions--">deleteAllVersions</a></span>()</code> |
| <div class="block">Deletes this document and all its versions.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteContentStream--">deleteContentStream</a></span>()</code> |
| <div class="block">Removes the current content stream from the document and refreshes this |
| object afterwards.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#deleteContentStream-boolean-">deleteContentStream</a></span>(boolean refresh)</code> |
| <div class="block">Removes the current content stream from the document.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getAllVersions--">getAllVersions</a></span>()</code> |
| <div class="block">Fetches all versions of this document.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getAllVersions-org.apache.chemistry.opencmis.client.api.OperationContext-">getAllVersions</a></span>(<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 id="i17" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream--">getContentStream</a></span>()</code> |
| <div class="block">Retrieves the content stream of this document.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream-java.math.BigInteger-java.math.BigInteger-">getContentStream</a></span>(<a href="http://docs.oracle.com/javase/7/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/7/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 id="i19" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream-java.lang.String-">getContentStream</a></span>(<a href="http://docs.oracle.com/javase/7/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 id="i20" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentStream-java.lang.String-java.math.BigInteger-java.math.BigInteger-">getContentStream</a></span>(<a href="http://docs.oracle.com/javase/7/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/7/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/7/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 id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentUrl--">getContentUrl</a></span>()</code> |
| <div class="block">Returns the content URL of the document if the binding supports content |
| URLs.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getContentUrl-java.lang.String-">getContentUrl</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">Returns the content URL of the document or a rendition if the binding |
| supports content URLs.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentType.html" title="interface in org.apache.chemistry.opencmis.client.api">DocumentType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getDocumentType--">getDocumentType</a></span>()</code> |
| <div class="block">Returns the object type as a document type.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getObjectOfLatestVersion-boolean-">getObjectOfLatestVersion</a></span>(boolean major)</code> |
| <div class="block">Fetches the latest major or minor version of this document.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#getObjectOfLatestVersion-boolean-org.apache.chemistry.opencmis.client.api.OperationContext-">getObjectOfLatestVersion</a></span>(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 id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#isVersionable--">isVersionable</a></span>()</code> |
| <div class="block">Returns whether the document is versionable or not.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#isVersionSeriesPrivateWorkingCopy--">isVersionSeriesPrivateWorkingCopy</a></span>()</code> |
| <div class="block">Determines whether this document is the PWC in the version series or not.</div> |
| </td> |
| </tr> |
| <tr id="i28" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#setContentStream-org.apache.chemistry.opencmis.commons.data.ContentStream-boolean-">setContentStream</a></span>(<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 id="i29" 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><span class="memberNameLink"><a href="../../../../../../org/apache/chemistry/opencmis/client/api/Document.html#setContentStream-org.apache.chemistry.opencmis.commons.data.ContentStream-boolean-boolean-">setContentStream</a></span>(<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#applyPolicy-org.apache.chemistry.opencmis.client.api.ObjectId-boolean-">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#getPermissionsForPrincipal-java.lang.String-">getPermissionsForPrincipal</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getPolicies--">getPolicies</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#getPolicyIds--">getPolicyIds</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#hasAllowableAction-org.apache.chemistry.opencmis.commons.enums.Action-">hasAllowableAction</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#removePolicy-org.apache.chemistry.opencmis.client.api.ObjectId-boolean-">removePolicy</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#rename-java.lang.String-">rename</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#rename-java.lang.String-boolean-">rename</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>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#updateProperties-java.util.Map-java.util.List-java.util.List-">updateProperties</a>, <a href="../../../../../../org/apache/chemistry/opencmis/client/api/CmisObject.html#updateProperties-java.util.Map-java.util.List-java.util.List-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#getContentStreamHashes--">getContentStreamHashes</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#getLatestAccessibleStateId--">getLatestAccessibleStateId</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="getDocumentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDocumentType</h4> |
| <pre><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentType.html" title="interface in org.apache.chemistry.opencmis.client.api">DocumentType</a> getDocumentType()</pre> |
| <div class="block">Returns the object type as a document type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the document type</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the object type is not a document type</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isVersionable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVersionable</h4> |
| <pre>boolean isVersionable()</pre> |
| <div class="block">Returns whether the document is versionable or not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the document is versionable, <code>false</code> if the |
| document is not versionable or if it's unknown</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isVersionSeriesPrivateWorkingCopy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVersionSeriesPrivateWorkingCopy</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isVersionSeriesPrivateWorkingCopy()</pre> |
| <div class="block">Determines whether this document is the PWC in the version series or not. |
| |
| The evaluation is based on the properties |
| <code>cmis:isVersionSeriesCheckedOut</code>, |
| <code>cmis:isPrivateWorkingCopy</code>, and |
| <code>cmis:versionSeriesCheckedOutId</code> and works for all CMIS versions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if it is the PWC, <code>false</code> if it is not the |
| PWC, or <code>null</code> if it can't be determined</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/chemistry/opencmis/client/api/DocumentProperties.html#isPrivateWorkingCopy--"><code>DocumentProperties.isPrivateWorkingCopy()</code></a></dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </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="simpleTagLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the content stream, or <code>null</code> if the document has no |
| content</dd> |
| <dt><span class="simpleTagLabel">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/7/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/7/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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the content stream, or <code>null</code> if the document has no |
| content</dd> |
| <dt><span class="simpleTagLabel">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/7/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="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - the stream ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the content stream, or <code>null</code> if no content is associated |
| with this stream ID</dd> |
| <dt><span class="simpleTagLabel">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/7/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/7/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/7/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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the content stream, or <code>null</code> if no content is associated |
| with this stream ID</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentUrl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentUrl</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContentUrl()</pre> |
| <div class="block">Returns the content URL of the document if the binding supports content |
| URLs. |
| |
| Depending on the repository and the binding, the server might not return |
| the content but an error message. Authentication data is not attached. |
| That is, a user may have to re-authenticate to get the content.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the content URL of the document or <code>null</code> if the binding |
| does not support content URLs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentUrl-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentUrl</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContentUrl(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block">Returns the content URL of the document or a rendition if the binding |
| supports content URLs. |
| |
| Depending on the repository and the binding, the server might not return |
| the content but an error message. Authentication data is not attached. |
| That is, a user may have to re-authenticate to get the content.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - the ID of the rendition or <code>null</code> for the document</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the content URL of the document or rendition or <code>null</code> if |
| the binding does not support content URLs</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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the updated document, or <code>null</code> if the repository did not |
| return an object ID</dd> |
| <dt><span class="seeLabel">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="simpleTagLabel">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="paramLabel">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="returnLabel">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="seeLabel">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="simpleTagLabel">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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the updated document, or <code>null</code> if the repository did not |
| return an object ID</dd> |
| <dt><span class="seeLabel">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="simpleTagLabel">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="paramLabel">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="returnLabel">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="simpleTagLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the updated document, or <code>null</code> if the repository did not |
| return an object ID</dd> |
| <dt><span class="simpleTagLabel">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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the updated document, or <code>null</code> if the repository did not |
| return an object ID</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOverwriteOutputStream-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOverwriteOutputStream</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> createOverwriteOutputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType)</pre> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to |
| overwrite the current content of the document.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filename</code> - the file name</dd> |
| <dd><code>mimeType</code> - the MIME type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the OutputStream object</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOverwriteOutputStream-java.lang.String-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOverwriteOutputStream</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> createOverwriteOutputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mimeType, |
| int bufferSize)</pre> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to |
| overwrite the current content of the document.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filename</code> - the file name</dd> |
| <dd><code>mimeType</code> - the MIME type</dd> |
| <dd><code>bufferSize</code> - buffer size in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the OutputStream object</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAppendOutputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAppendOutputStream</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> createAppendOutputStream()</pre> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to append |
| content the current content of the document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the OutputStream object</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAppendOutputStream-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAppendOutputStream</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> createAppendOutputStream(int bufferSize)</pre> |
| <div class="block">Creates an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> stream object that can be used to append |
| content the current content of the document.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bufferSize</code> - buffer size in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the OutputStream object</dd> |
| <dt><span class="simpleTagLabel">CMIS:</span></dt> |
| <dd>1.1</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="returnLabel">Returns:</span></dt> |
| <dd>PWC object ID</dd> |
| <dt><span class="simpleTagLabel">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="simpleTagLabel">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/7/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/7/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/7/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/7/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/7/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/7/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="returnLabel">Returns:</span></dt> |
| <dd>new document ID</dd> |
| <dt><span class="simpleTagLabel">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/7/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/7/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/7/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="returnLabel">Returns:</span></dt> |
| <dd>new document ID</dd> |
| <dt><span class="simpleTagLabel">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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the latest document object</dd> |
| <dt><span class="simpleTagLabel">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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the latest document object</dd> |
| <dt><span class="simpleTagLabel">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/7/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. |
| <p> |
| The behavior of this method is undefined if the document is not |
| versionable and can be different for each repository.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all versions of the version series, sorted by |
| <code>cmis:creationDate</code> descending and preceded by the PWC, if |
| one exists, not <code>null</code></dd> |
| <dt><span class="simpleTagLabel">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/7/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>. |
| <p> |
| The behavior of this method is undefined if the document is not |
| versionable and can be different for each repository.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all versions of the version series, sorted by |
| <code>cmis:creationDate</code> descending and preceded by the PWC, if |
| one exists, not <code>null</code></dd> |
| <dt><span class="simpleTagLabel">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="paramLabel">Parameters:</span></dt> |
| <dd><code>targetFolderId</code> - the ID of the target folder, <code>null</code> to create an unfiled |
| document</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new document object</dd> |
| <dt><span class="simpleTagLabel">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/7/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/7/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/7/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/7/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/7/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="paramLabel">Parameters:</span></dt> |
| <dd><code>targetFolderId</code> - the ID of the target folder, <code>null</code> to create an unfiled |
| document</dd> |
| <dt><span class="returnLabel">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="simpleTagLabel">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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="typeNameLink">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="typeNameLink">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–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
