| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>Code — Apache Chemistry cmislib 0.6.0 documentation</title> |
| |
| <link rel="stylesheet" href="_static/classic.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: './', |
| VERSION: '0.6.0', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <link rel="author" title="About these documents" href="about.html" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Miscellaneous Code" href="codemisc.html" /> |
| <link rel="prev" title="Bindings" href="bindings.html" /> |
| </head> |
| <body role="document"> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="right" > |
| <a href="py-modindex.html" title="Python Module Index" |
| >modules</a> |</li> |
| <li class="right" > |
| <a href="codemisc.html" title="Miscellaneous Code" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="bindings.html" title="Bindings" |
| accesskey="P">previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="code"> |
| <h1>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="the-cmislib-model-module"> |
| <h2>The <a class="reference internal" href="#module-cmislib.model" title="cmislib.model"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.model</span></code></a> Module<a class="headerlink" href="#the-cmislib-model-module" title="Permalink to this headline">¶</a></h2> |
| <p>When working with the repository, the first thing you need to do is grab an instance of <code class="xref py py-class docutils literal"><span class="pre">cmislib.CmisClient</span></code>, passing it the repository endpoint URL, username, and password.</p> |
| <p>For example, in Alfresco 4.2 and higher, the repository endpoint for CMIS 1.1 and the Atom Pub binding is |
| ‘<a class="reference external" href="http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom">http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom</a>‘. Earlier versions have different URLs. |
| The default username and password are typically ‘admin’ and ‘admin’.</p> |
| <p>So, to connect to an Alfresco server running on localhost, you would use:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cmisClient</span> <span class="o">=</span> <span class="n">cmislib</span><span class="o">.</span><span class="n">CmisClient</span><span class="p">(</span><span class="s1">'http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom'</span><span class="p">,</span> <span class="s1">'admin'</span><span class="p">,</span> <span class="s1">'admin'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>From there you can get the default repository...</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">cmisClient</span><span class="o">.</span><span class="n">defaultRepository</span> |
| </pre></div> |
| </div> |
| <p>An Alfresco server has a single repository. Servers from other vendors may have multiple repositories. In those cases, you can get a specific repository if you know the repository ID.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">cmisClient</span><span class="o">.</span><span class="n">getRepository</span><span class="p">(</span><span class="s1">'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Once you have that, you’re off to the races. Use the <code class="xref py py-class docutils literal"><span class="pre">cmislib.Repository</span></code> class to create new <code class="xref py py-class docutils literal"><span class="pre">cmislib.Folder</span></code> and <code class="xref py py-class docutils literal"><span class="pre">cmislib.Document</span></code> objects, perform searches, etc.</p> |
| <span class="target" id="module-cmislib.model"></span><p>The model module contains the CmisClient object, which is responsible for |
| keeping track of connection information. The name ‘model’ is no longer |
| really appropriate, but it is kept for backwards compatibility.</p> |
| <dl class="class"> |
| <dt id="cmislib.model.CmisClient"> |
| <em class="property">class </em><code class="descclassname">cmislib.model.</code><code class="descname">CmisClient</code><span class="sig-paren">(</span><em>repositoryUrl</em>, <em>username</em>, <em>password</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.model.CmisClient" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Handles all communication with the CMIS provider.</p> |
| <dl class="attribute"> |
| <dt id="cmislib.model.CmisClient.defaultRepository"> |
| <code class="descname">defaultRepository</code><a class="headerlink" href="#cmislib.model.CmisClient.defaultRepository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>There does not appear to be anything in the spec that identifies |
| a repository as being the default, so we’ll define it to be the |
| first one in the list.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryId</span><span class="p">()</span> |
| <span class="go">u'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.model.CmisClient.getDefaultRepository"> |
| <code class="descname">getDefaultRepository</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.model.CmisClient.getDefaultRepository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>There does not appear to be anything in the spec that identifies |
| a repository as being the default, so we’ll define it to be the |
| first one in the list.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryId</span><span class="p">()</span> |
| <span class="go">u'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.model.CmisClient.getRepositories"> |
| <code class="descname">getRepositories</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.model.CmisClient.getRepositories" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of high-level info about the repositories available at |
| this service. The dict contains entries for ‘repositoryId’ and |
| ‘repositoryName’.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">getRepositories</span><span class="p">()</span> |
| <span class="go">[{'repositoryName': u'Main Repository', 'repositoryId': u'83beb297-a6fa-4ac5-844b-98c871c0eea9'}]</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.model.CmisClient.getRepository"> |
| <code class="descname">getRepository</code><span class="sig-paren">(</span><em>repositoryId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.model.CmisClient.getRepository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the repository identified by the specified repositoryId.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getRepository</span><span class="p">(</span><span class="s1">'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryName</span><span class="p">()</span> |
| <span class="go">u'Main Repository'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.model.CmisClient.repositories"> |
| <code class="descname">repositories</code><a class="headerlink" href="#cmislib.model.CmisClient.repositories" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of high-level info about the repositories available at |
| this service. The dict contains entries for ‘repositoryId’ and |
| ‘repositoryName’.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">getRepositories</span><span class="p">()</span> |
| <span class="go">[{'repositoryName': u'Main Repository', 'repositoryId': u'83beb297-a6fa-4ac5-844b-98c871c0eea9'}]</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="the-cmislib-domain-module"> |
| <h2>The <a class="reference internal" href="#module-cmislib.domain" title="cmislib.domain"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.domain</span></code></a> Module<a class="headerlink" href="#the-cmislib-domain-module" title="Permalink to this headline">¶</a></h2> |
| <p>These are the generic domain objects that establish the interface to the cmislib API. Regardless of which actual binding you use (AtomPub or Browser), you will work with these objects.</p> |
| <span class="target" id="module-cmislib.domain"></span><p>This module contains the domain objects used to work with a CMIS provider.</p> |
| <dl class="class"> |
| <dt id="cmislib.domain.ACE"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ACE</code><span class="sig-paren">(</span><em>principalId=None</em>, <em>permissions=None</em>, <em>direct=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents an individual Access Control Entry.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.ACE.copy"> |
| <code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACE.copy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>return a deep copy of the ace instance</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ACE.direct"> |
| <code class="descname">direct</code><a class="headerlink" href="#cmislib.domain.ACE.direct" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for direct</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ACE.permissions"> |
| <code class="descname">permissions</code><a class="headerlink" href="#cmislib.domain.ACE.permissions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for permissions</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ACE.principalId"> |
| <code class="descname">principalId</code><a class="headerlink" href="#cmislib.domain.ACE.principalId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for principalId</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.ACL"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ACL</code><a class="headerlink" href="#cmislib.domain.ACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents the Access Control List for an object.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.ACL.addEntry"> |
| <code class="descname">addEntry</code><span class="sig-paren">(</span><em>principalId</em>, <em>access</em>, <em>direct</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACL.addEntry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Adds an <a class="reference internal" href="#cmislib.domain.ACE" title="cmislib.domain.ACE"><code class="xref py py-class docutils literal"><span class="pre">ACE</span></code></a> entry to the ACL.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="s1">'jpotts'</span><span class="p">,</span> <span class="s1">'cmis:read'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="s1">'jsmith'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x100731410>, u'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x100731150>, 'jpotts': <cmislib.atompub.binding.AtomPubACE object at 0x1005a22d0>, 'jsmith': <cmislib.atompub.binding.AtomPubACE object at 0x1005a2210>}</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ACL.clearEntries"> |
| <code class="descname">clearEntries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACL.clearEntries" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Clears all <a class="reference internal" href="#cmislib.domain.ACE" title="cmislib.domain.ACE"><code class="xref py py-class docutils literal"><span class="pre">ACE</span></code></a> entries from the ACL and removes the internal |
| XML representation of the ACL.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">ACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jsmith'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jpotts'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">entries</span> |
| <span class="go">{'jpotts': <cmislib.atompub.binding.AtomPubACE object at 0x1012c7310>, 'jsmith': <cmislib.atompub.binding.AtomPubACE object at 0x100528490>}</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getXmlDoc</span><span class="p">()</span> |
| <span class="go"><xml.dom.minidom.Document instance at 0x1012cbb90></span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">clearEntries</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">entries</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getXmlDoc</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ACL.entries"> |
| <code class="descname">entries</code><a class="headerlink" href="#cmislib.domain.ACL.entries" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of <a class="reference internal" href="#cmislib.domain.ACE" title="cmislib.domain.ACE"><code class="xref py py-class docutils literal"><span class="pre">ACE</span></code></a> objects for each Access Control |
| Entry in the ACL. The key value is the ACE principalid.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">ACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jsmith'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jpotts'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">ace</span> <span class="ow">in</span> <span class="n">acl</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'principal:</span><span class="si">%s</span><span class="s1"> has the following permissions...'</span> <span class="o">%</span> <span class="n">ace</span><span class="o">.</span><span class="n">principalId</span> |
| <span class="gp">... </span> <span class="k">for</span> <span class="n">perm</span> <span class="ow">in</span> <span class="n">ace</span><span class="o">.</span><span class="n">permissions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">perm</span> |
| <span class="gp">...</span> |
| <span class="go">principal:jpotts has the following permissions...</span> |
| <span class="go">cmis:write</span> |
| <span class="go">principal:jsmith has the following permissions...</span> |
| <span class="go">cmis:write</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ACL.getEntries"> |
| <code class="descname">getEntries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACL.getEntries" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of <a class="reference internal" href="#cmislib.domain.ACE" title="cmislib.domain.ACE"><code class="xref py py-class docutils literal"><span class="pre">ACE</span></code></a> objects for each Access Control |
| Entry in the ACL. The key value is the ACE principalid.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">ACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jsmith'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jpotts'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">ace</span> <span class="ow">in</span> <span class="n">acl</span><span class="o">.</span><span class="n">entries</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'principal:</span><span class="si">%s</span><span class="s1"> has the following permissions...'</span> <span class="o">%</span> <span class="n">ace</span><span class="o">.</span><span class="n">principalId</span> |
| <span class="gp">... </span> <span class="k">for</span> <span class="n">perm</span> <span class="ow">in</span> <span class="n">ace</span><span class="o">.</span><span class="n">permissions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">perm</span> |
| <span class="gp">...</span> |
| <span class="go">principal:jpotts has the following permissions...</span> |
| <span class="go">cmis:write</span> |
| <span class="go">principal:jsmith has the following permissions...</span> |
| <span class="go">cmis:write</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ACL.removeEntry"> |
| <code class="descname">removeEntry</code><span class="sig-paren">(</span><em>principalId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ACL.removeEntry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Removes the <a class="reference internal" href="#cmislib.domain.ACE" title="cmislib.domain.ACE"><code class="xref py py-class docutils literal"><span class="pre">ACE</span></code></a> entry given a specific principalId.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x100731410>, u'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x100731150>, 'jpotts': <cmislib.atompub.binding.AtomPubACE object at 0x1005a22d0>, 'jsmith': <cmislib.atompub.binding.AtomPubACE object at 0x1005a2210>}</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">removeEntry</span><span class="p">(</span><span class="s1">'jsmith'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x100731410>, u'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x100731150>, 'jpotts': <cmislib.atompub.binding.AtomPubACE object at 0x1005a22d0>}</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.ChangeEntry"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ChangeEntry</code><a class="headerlink" href="#cmislib.domain.ChangeEntry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents a change log entry. Retrieve a list of change entries via |
| <a class="reference internal" href="#cmislib.domain.Repository.getContentChanges" title="cmislib.domain.Repository.getContentChanges"><code class="xref py py-meth docutils literal"><span class="pre">Repository.getContentChanges()</span></code></a>.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">changeEntry</span> <span class="ow">in</span> <span class="n">rs</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">objectId</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">id</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">changeType</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">changeTime</span> |
| <span class="gp">...</span> |
| <span class="go">'workspace://SpacesStore/0e2dc775-16b7-4634-9e54-2417a196829b'</span> |
| <span class="go">u'urn:uuid:0e2dc775-16b7-4634-9e54-2417a196829b'</span> |
| <span class="go">u'created'</span> |
| <span class="go">datetime.datetime(2010, 2, 11, 12, 55, 14)</span> |
| <span class="go">'workspace://SpacesStore/bd768f9f-99a7-4033-828d-5b13f96c6923'</span> |
| <span class="go">u'urn:uuid:bd768f9f-99a7-4033-828d-5b13f96c6923'</span> |
| <span class="go">u'updated'</span> |
| <span class="go">datetime.datetime(2010, 2, 11, 12, 55, 13)</span> |
| <span class="go">'workspace://SpacesStore/572c2cac-6b26-4cd8-91ad-b2931fe5b3fb'</span> |
| <span class="go">u'urn:uuid:572c2cac-6b26-4cd8-91ad-b2931fe5b3fb'</span> |
| <span class="go">u'updated'</span> |
| </pre></div> |
| </div> |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ChangeEntry.changeTime"> |
| <code class="descname">changeTime</code><a class="headerlink" href="#cmislib.domain.ChangeEntry.changeTime" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a datetime object representing the time the change occurred.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ChangeEntry.changeType"> |
| <code class="descname">changeType</code><a class="headerlink" href="#cmislib.domain.ChangeEntry.changeType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the type of change that occurred. The resulting value must be |
| one of:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>created</li> |
| <li>updated</li> |
| <li>deleted</li> |
| <li>security</li> |
| </ul> |
| </div></blockquote> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getACL"> |
| <code class="descname">getACL</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the <a class="reference internal" href="#cmislib.domain.ACL" title="cmislib.domain.ACL"><code class="xref py py-class docutils literal"><span class="pre">ACL</span></code></a> object that is included with this Change Entry.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getChangeTime"> |
| <code class="descname">getChangeTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getChangeTime" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a datetime object representing the time the change occurred.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getChangeType"> |
| <code class="descname">getChangeType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getChangeType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the type of change that occurred. The resulting value must be |
| one of:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>created</li> |
| <li>updated</li> |
| <li>deleted</li> |
| <li>security</li> |
| </ul> |
| </div></blockquote> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getId"> |
| <code class="descname">getId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the unique ID of the change entry.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getObjectId"> |
| <code class="descname">getObjectId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getObjectId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object ID of the object that changed.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntry.getProperties"> |
| <code class="descname">getProperties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntry.getProperties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the properties of the change entry. Note that depending on the |
| capabilities of the repository (“capabilityChanges”) the list may not |
| include the actual property values that changed.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ChangeEntry.id"> |
| <code class="descname">id</code><a class="headerlink" href="#cmislib.domain.ChangeEntry.id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the unique ID of the change entry.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ChangeEntry.objectId"> |
| <code class="descname">objectId</code><a class="headerlink" href="#cmislib.domain.ChangeEntry.objectId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object ID of the object that changed.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ChangeEntry.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#cmislib.domain.ChangeEntry.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the properties of the change entry. Note that depending on the |
| capabilities of the repository (“capabilityChanges”) the list may not |
| include the actual property values that changed.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.ChangeEntryResultSet"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ChangeEntryResultSet</code><a class="headerlink" href="#cmislib.domain.ChangeEntryResultSet" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A specialized type of <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> that knows how to instantiate |
| <a class="reference internal" href="#cmislib.domain.ChangeEntry" title="cmislib.domain.ChangeEntry"><code class="xref py py-class docutils literal"><span class="pre">ChangeEntry</span></code></a> objects. The parent class assumes children of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> which doesn’t work for ChangeEntries.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.ChangeEntryResultSet.getResults"> |
| <code class="descname">getResults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ChangeEntryResultSet.getResults" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Overriding to make it work with a list instead of a dict.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.CmisId"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">CmisId</code><a class="headerlink" href="#cmislib.domain.CmisId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is a marker class to be used for Strings that are used as CMIS ID’s. |
| Making the objects instances of this class makes it easier to create the |
| Atom entry XML with the appropriate type, ie, cmis:propertyId, instead of |
| cmis:propertyString.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.CmisObject"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">CmisObject</code><a class="headerlink" href="#cmislib.domain.CmisObject" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Common ancestor class for other CMIS domain objects such as |
| <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> and <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a>.</p> |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.ACL"> |
| <code class="descname">ACL</code><a class="headerlink" href="#cmislib.domain.CmisObject.ACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Repository.getCapabilities[‘ACL’] must return manage or discover.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x10071a8d0>, 'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x10071a590>}</span> |
| </pre></div> |
| </div> |
| <p>The optional onlyBasicPermissions argument is currently not supported.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.allowableActions"> |
| <code class="descname">allowableActions</code><a class="headerlink" href="#cmislib.domain.CmisObject.allowableActions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of allowable actions, keyed off of the action name.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">actions</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getAllowableActions</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="n">actions</span><span class="p">[</span><span class="n">a</span><span class="p">])</span> |
| <span class="gp">...</span> |
| <span class="go">canDeleteContentStream:True</span> |
| <span class="go">canSetContentStream:True</span> |
| <span class="go">canCreateRelationship:True</span> |
| <span class="go">canCheckIn:False</span> |
| <span class="go">canApplyACL:False</span> |
| <span class="go">canDeleteObject:True</span> |
| <span class="go">canGetAllVersions:True</span> |
| <span class="go">canGetObjectParents:True</span> |
| <span class="go">canGetProperties:True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.applyACL"> |
| <code class="descname">applyACL</code><span class="sig-paren">(</span><em>acl</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.applyACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the object with the provided <a class="reference internal" href="#cmislib.domain.ACL" title="cmislib.domain.ACL"><code class="xref py py-class docutils literal"><span class="pre">ACL</span></code></a>. |
| Repository.getCapabilities[‘ACL’] must return manage to invoke this |
| call.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">addEntry</span><span class="p">(</span><span class="n">ACE</span><span class="p">(</span><span class="s1">'jdoe'</span><span class="p">,</span> <span class="s1">'cmis:write'</span><span class="p">,</span> <span class="s1">'true'</span><span class="p">))</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x10071a8d0>, 'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x10071a590>}</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.applyPolicy"> |
| <code class="descname">applyPolicy</code><span class="sig-paren">(</span><em>policyId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.applyPolicy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is not yet implemented.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.createRelationship"> |
| <code class="descname">createRelationship</code><span class="sig-paren">(</span><em>targetObj</em>, <em>relTypeId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.createRelationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a relationship between this object and a specified target |
| object using the relationship type specified. Returns the new |
| <a class="reference internal" href="#cmislib.domain.Relationship" title="cmislib.domain.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">rel</span> <span class="o">=</span> <span class="n">tstDoc1</span><span class="o">.</span><span class="n">createRelationship</span><span class="p">(</span><span class="n">tstDoc2</span><span class="p">,</span> <span class="s1">'R:cmiscustom:assoc'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">rel</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()</span> |
| <span class="go">{u'cmis:objectId': u'workspace://SpacesStore/271c48dd-6548-4771-a8f5-0de69b7cdc25', u'cmis:creationDate': None, u'cmis:objectTypeId': u'R:cmiscustom:assoc', u'cmis:lastModificationDate': None, u'cmis:targetId': u'workspace://SpacesStore/0ca1aa08-cb49-42e2-8881-53aa8496a1c1', u'cmis:lastModifiedBy': None, u'cmis:baseTypeId': u'cmis:relationship', u'cmis:sourceId': u'workspace://SpacesStore/271c48dd-6548-4771-a8f5-0de69b7cdc25', u'cmis:changeToken': None, u'cmis:createdBy': None}</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.delete"> |
| <code class="descname">delete</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.delete" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes this <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> from the repository. Note that in the |
| case of a <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> object, some repositories will refuse to |
| delete it if it contains children and some will delete it without |
| complaint. If what you really want to do is delete the folder and all |
| of its descendants, use <a class="reference internal" href="#cmislib.domain.Folder.deleteTree" title="cmislib.domain.Folder.deleteTree"><code class="xref py py-meth docutils literal"><span class="pre">deleteTree()</span></code></a> instead.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <p>The optional allVersions argument is supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getACL"> |
| <code class="descname">getACL</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Repository.getCapabilities[‘ACL’] must return manage or discover.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">acl</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getACL</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">acl</span><span class="o">.</span><span class="n">getEntries</span><span class="p">()</span> |
| <span class="go">{u'GROUP_EVERYONE': <cmislib.atompub.binding.AtomPubACE object at 0x10071a8d0>, 'jdoe': <cmislib.atompub.binding.AtomPubACE object at 0x10071a590>}</span> |
| </pre></div> |
| </div> |
| <p>The optional onlyBasicPermissions argument is currently not supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getAllowableActions"> |
| <code class="descname">getAllowableActions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getAllowableActions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of allowable actions, keyed off of the action name.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">actions</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getAllowableActions</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="n">actions</span><span class="p">[</span><span class="n">a</span><span class="p">])</span> |
| <span class="gp">...</span> |
| <span class="go">canDeleteContentStream:True</span> |
| <span class="go">canSetContentStream:True</span> |
| <span class="go">canCreateRelationship:True</span> |
| <span class="go">canCheckIn:False</span> |
| <span class="go">canApplyACL:False</span> |
| <span class="go">canDeleteObject:True</span> |
| <span class="go">canGetAllVersions:True</span> |
| <span class="go">canGetObjectParents:True</span> |
| <span class="go">canGetProperties:True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getAppliedPolicies"> |
| <code class="descname">getAppliedPolicies</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getAppliedPolicies" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is not yet implemented.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getName"> |
| <code class="descname">getName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of cmis:name from the getProperties() dictionary. |
| We don’t need a getter for every standard CMIS property, but name |
| is a pretty common one so it seems to make sense.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'system-overview.html'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getObjectId"> |
| <code class="descname">getObjectId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getObjectId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object ID for this object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/dc26102b-e312-471b-b2af-91bfb0225339'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getObjectParents"> |
| <code class="descname">getObjectParents</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getObjectParents" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the parents of this object as a <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a>.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| <li>includeRelativePathSegment</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getPaths"> |
| <code class="descname">getPaths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getPaths" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object’s paths as a list of strings.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getProperties"> |
| <code class="descname">getProperties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getProperties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of the object’s properties. If CMIS returns an |
| empty element for a property, the property will be in the |
| dict with a value of None.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">props</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">props</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="n">p</span><span class="p">])</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:contentStreamMimeType: text/html</span> |
| <span class="go">cmis:creationDate: 2009-12-15T09:45:35.369-06:00</span> |
| <span class="go">cmis:baseTypeId: cmis:document</span> |
| <span class="go">cmis:isLatestMajorVersion: false</span> |
| <span class="go">cmis:isImmutable: false</span> |
| <span class="go">cmis:isMajorVersion: false</span> |
| <span class="go">cmis:objectId: workspace://SpacesStore/dc26102b-e312-471b-b2af-91bfb0225339</span> |
| </pre></div> |
| </div> |
| <p>The optional filter argument is not yet implemented.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getRelationships"> |
| <code class="descname">getRelationships</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getRelationships" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> of <a class="reference internal" href="#cmislib.domain.Relationship" title="cmislib.domain.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> objects for each |
| relationship where the source is this object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">rels</span> <span class="o">=</span> <span class="n">tstDoc1</span><span class="o">.</span><span class="n">getRelationships</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rels</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="n">rel</span> <span class="o">=</span> <span class="n">rels</span><span class="o">.</span><span class="n">getResults</span><span class="p">()</span><span class="o">.</span><span class="n">values</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="gp">>>> </span><span class="n">rel</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()</span> |
| <span class="go">{u'cmis:objectId': u'workspace://SpacesStore/271c48dd-6548-4771-a8f5-0de69b7cdc25', u'cmis:creationDate': None, u'cmis:objectTypeId': u'R:cmiscustom:assoc', u'cmis:lastModificationDate': None, u'cmis:targetId': u'workspace://SpacesStore/0ca1aa08-cb49-42e2-8881-53aa8496a1c1', u'cmis:lastModifiedBy': None, u'cmis:baseTypeId': u'cmis:relationship', u'cmis:sourceId': u'workspace://SpacesStore/271c48dd-6548-4771-a8f5-0de69b7cdc25', u'cmis:changeToken': None, u'cmis:createdBy': None}</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>includeSubRelationshipTypes</li> |
| <li>relationshipDirection</li> |
| <li>typeId</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| <li>filter</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getRepository"> |
| <code class="descname">getRepository</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getRepository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object’s repository</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.getTitle"> |
| <code class="descname">getTitle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.getTitle" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of the object’s cmis:title property.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.id"> |
| <code class="descname">id</code><a class="headerlink" href="#cmislib.domain.CmisObject.id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object ID for this object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/dc26102b-e312-471b-b2af-91bfb0225339'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.move"> |
| <code class="descname">move</code><span class="sig-paren">(</span><em>sourceFolder</em>, <em>targetFolder</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.move" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Moves an object from the source folder to the target folder.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sub1</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">'/cmislib/sub1'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">sub2</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">'/cmislib/sub2'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">'/cmislib/sub1/testdoc1'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">sub1</span><span class="p">,</span> <span class="n">sub2</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.name"> |
| <code class="descname">name</code><a class="headerlink" href="#cmislib.domain.CmisObject.name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of cmis:name from the getProperties() dictionary. |
| We don’t need a getter for every standard CMIS property, but name |
| is a pretty common one so it seems to make sense.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'system-overview.html'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#cmislib.domain.CmisObject.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of the object’s properties. If CMIS returns an |
| empty element for a property, the property will be in the |
| dict with a value of None.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">props</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">props</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="n">p</span><span class="p">])</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:contentStreamMimeType: text/html</span> |
| <span class="go">cmis:creationDate: 2009-12-15T09:45:35.369-06:00</span> |
| <span class="go">cmis:baseTypeId: cmis:document</span> |
| <span class="go">cmis:isLatestMajorVersion: false</span> |
| <span class="go">cmis:isImmutable: false</span> |
| <span class="go">cmis:isMajorVersion: false</span> |
| <span class="go">cmis:objectId: workspace://SpacesStore/dc26102b-e312-471b-b2af-91bfb0225339</span> |
| </pre></div> |
| </div> |
| <p>The optional filter argument is not yet implemented.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.reload"> |
| <code class="descname">reload</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.reload" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Fetches the latest representation of this object from the CMIS service. |
| Some methods, like <code class="xref py py-class docutils literal"><span class="pre">^Document.checkout</span></code> do this for you.</p> |
| <p>If you call reload with a properties filter, the filter will be in |
| effect on subsequent calls until the filter argument is changed. To |
| reset to the full list of properties, call reload with filter set to |
| ‘*’.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.removePolicy"> |
| <code class="descname">removePolicy</code><span class="sig-paren">(</span><em>policyId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.removePolicy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is not yet implemented.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.repository"> |
| <code class="descname">repository</code><a class="headerlink" href="#cmislib.domain.CmisObject.repository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the object’s repository</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.CmisObject.title"> |
| <code class="descname">title</code><a class="headerlink" href="#cmislib.domain.CmisObject.title" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of the object’s cmis:title property.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.CmisObject.updateProperties"> |
| <code class="descname">updateProperties</code><span class="sig-paren">(</span><em>properties</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.CmisObject.updateProperties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Updates the properties of an object with the properties provided. |
| Only provide the set of properties that need to be updated.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">folder</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">'/someFolder2'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'someFolder2'</span> |
| <span class="gp">>>> </span><span class="n">props</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'cmis:name'</span><span class="p">:</span> <span class="s1">'someFolderFoo'</span><span class="p">}</span> |
| <span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">updateProperties</span><span class="p">(</span><span class="n">props</span><span class="p">)</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubFolder object at 0x103ab1210></span> |
| <span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'someFolderFoo'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Document"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Document</code><a class="headerlink" href="#cmislib.domain.Document" title="Permalink to this definition">¶</a></dt> |
| <dd><p>An object typically associated with file content.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.cancelCheckout"> |
| <code class="descname">cancelCheckout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.cancelCheckout" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Cancels the checkout of this object by retrieving the Private Working |
| Copy (PWC) and then deleting it. After the PWC is deleted, this object |
| will be reloaded to update properties related to a checkout.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">cancelCheckout</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Document.checkedOut"> |
| <code class="descname">checkedOut</code><a class="headerlink" href="#cmislib.domain.Document.checkedOut" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns true if the document is checked out.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">cancelCheckout</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.checkin"> |
| <code class="descname">checkin</code><span class="sig-paren">(</span><em>checkinComment=None</em>, <em>contentFile=None</em>, <em>contentType=None</em>, <em>properties=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.checkin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Checks in this <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> which must be a private |
| working copy (PWC).</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| <span class="gp">>>> </span><span class="n">pwc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">checkout</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">pwc</span><span class="o">.</span><span class="n">checkin</span><span class="p">()</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x103a8ae90></span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are NOT supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.checkout"> |
| <code class="descname">checkout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.checkout" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Performs a checkout on the <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> and returns the |
| Private Working Copy (PWC), which is also an instance of |
| <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/f0c8b90f-bec0-4405-8b9c-2ab570589808;1.0'</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| <span class="gp">>>> </span><span class="n">pwc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">checkout</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.deleteContentStream"> |
| <code class="descname">deleteContentStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.deleteContentStream" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Delete’s the content stream associated with this object.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getAllVersions"> |
| <code class="descname">getAllVersions</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getAllVersions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> of document objects for the entire |
| version history of this object, including any PWC’s.</p> |
| <p>The optional filter and includeAllowableActions are |
| supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getCheckedOutBy"> |
| <code class="descname">getCheckedOutBy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getCheckedOutBy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the ID who currently has the document checked out. |
| >>> pwc = doc.checkout() |
| >>> pwc.getCheckedOutBy() |
| u’admin’</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getContentStream"> |
| <code class="descname">getContentStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getContentStream" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the CMIS service response from invoking the ‘enclosure’ link.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'sample-b.pdf'</span> |
| <span class="gp">>>> </span><span class="n">o</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'tmp.pdf'</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getContentStream</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> |
| <span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="kn">import</span> <span class="nn">os.path</span> |
| <span class="gp">>>> </span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="s1">'tmp.pdf'</span><span class="p">)</span> |
| <span class="go">117248</span> |
| </pre></div> |
| </div> |
| <p>The optional streamId argument is not yet supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getLatestVersion"> |
| <code class="descname">getLatestVersion</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getLatestVersion" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> object representing the latest version in |
| the version series.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>major</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>includePolicyIds</li> |
| <li>renditionFilter</li> |
| <li>includeACL</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">latestDoc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getLatestVersion</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">latestDoc</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()[</span><span class="s1">'cmis:versionLabel'</span><span class="p">]</span> |
| <span class="go">u'2.1'</span> |
| <span class="gp">>>> </span><span class="n">latestDoc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getLatestVersion</span><span class="p">(</span><span class="n">major</span><span class="o">=</span><span class="s1">'false'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">latestDoc</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()[</span><span class="s1">'cmis:versionLabel'</span><span class="p">]</span> |
| <span class="go">u'2.1'</span> |
| <span class="gp">>>> </span><span class="n">latestDoc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getLatestVersion</span><span class="p">(</span><span class="n">major</span><span class="o">=</span><span class="s1">'true'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">latestDoc</span><span class="o">.</span><span class="n">getProperties</span><span class="p">()[</span><span class="s1">'cmis:versionLabel'</span><span class="p">]</span> |
| <span class="go">u'2.0'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getPaths"> |
| <code class="descname">getPaths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getPaths" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the Document’s paths by asking for the parents with the |
| includeRelativePathSegment flag set to true, then concats the value |
| of cmis:path with the relativePathSegment.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getPrivateWorkingCopy"> |
| <code class="descname">getPrivateWorkingCopy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getPrivateWorkingCopy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Retrieves the object using the object ID in the property: |
| cmis:versionSeriesCheckedOutId then uses getObject to instantiate |
| the object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">checkout</span><span class="p">()</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x103a25ad0></span> |
| <span class="gp">>>> </span><span class="n">pwc</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getPrivateWorkingCopy</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">pwc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="go">u'sample-b (Working Copy).pdf'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getPropertiesOfLatestVersion"> |
| <code class="descname">getPropertiesOfLatestVersion</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getPropertiesOfLatestVersion" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Like <code class="xref py py-class docutils literal"><span class="pre">^CmisObject.getProperties</span></code>, returns a dict of properties |
| from the latest version of this object in the version series.</p> |
| <p>The optional major and filter arguments are supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.getRenditions"> |
| <code class="descname">getRenditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.getRenditions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an array of <a class="reference internal" href="#cmislib.domain.Rendition" title="cmislib.domain.Rendition"><code class="xref py py-class docutils literal"><span class="pre">Rendition</span></code></a> objects. The repository |
| must support the Renditions capability.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not currently supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>renditionFilter</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.isCheckedOut"> |
| <code class="descname">isCheckedOut</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.isCheckedOut" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns true if the document is checked out.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">cancelCheckout</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">isCheckedOut</span><span class="p">()</span> |
| <span class="go">False</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Document.setContentStream"> |
| <code class="descname">setContentStream</code><span class="sig-paren">(</span><em>contentFile</em>, <em>contentType=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Document.setContentStream" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the content stream on this object.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not yet supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>overwriteFlag=None</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Folder"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Folder</code><a class="headerlink" href="#cmislib.domain.Folder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A container object that can hold other <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.addObject"> |
| <code class="descname">addObject</code><span class="sig-paren">(</span><em>cmisObject</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.addObject" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Adds the specified object as a child of this object. No new object is |
| created. The repository must support multifiling for this to work.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sub1</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s2">"/cmislib/sub1"</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">sub2</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s2">"/cmislib/sub2"</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">sub1</span><span class="o">.</span><span class="n">createDocument</span><span class="p">(</span><span class="s2">"testdoc1"</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">sub1</span><span class="o">.</span><span class="n">getChildren</span><span class="p">())</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">sub2</span><span class="o">.</span><span class="n">getChildren</span><span class="p">())</span> |
| <span class="go">0</span> |
| <span class="gp">>>> </span><span class="n">sub2</span><span class="o">.</span><span class="n">addObject</span><span class="p">(</span><span class="n">doc</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">sub2</span><span class="o">.</span><span class="n">getChildren</span><span class="p">())</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="n">sub2</span><span class="o">.</span><span class="n">getChildren</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> |
| <span class="go">u'testdoc1'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>allVersions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.createDocument"> |
| <code class="descname">createDocument</code><span class="sig-paren">(</span><em>name</em>, <em>properties={}</em>, <em>contentFile=None</em>, <em>contentType=None</em>, <em>contentEncoding=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.createDocument" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new Document object in the repository using |
| the properties provided.</p> |
| <p>Right now this is basically the same as createFolder, |
| but this deals with contentStreams. The common logic should |
| probably be moved to CmisObject.createObject.</p> |
| <p>The method will attempt to guess the appropriate content |
| type and encoding based on the file. To specify it yourself, pass them |
| in via the contentType and contentEncoding arguments.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'250px-Cmis_logo.png'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">subFolder</span><span class="o">.</span><span class="n">createDocument</span><span class="p">(</span><span class="s1">'logo.png'</span><span class="p">,</span> <span class="n">contentFile</span><span class="o">=</span><span class="n">f</span><span class="p">)</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10410fa10></span> |
| <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <p>If you wanted to set one or more properties when creating the doc, pass |
| in a dict, like this:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">props</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'cmis:someProp'</span><span class="p">:</span><span class="s1">'someVal'</span><span class="p">}</span> |
| <span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'250px-Cmis_logo.png'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">subFolder</span><span class="o">.</span><span class="n">createDocument</span><span class="p">(</span><span class="s1">'logo.png'</span><span class="p">,</span> <span class="n">props</span><span class="p">,</span> <span class="n">contentFile</span><span class="o">=</span><span class="n">f</span><span class="p">)</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10410fa10></span> |
| <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <p>To specify a custom object type, pass in a property called |
| cmis:objectTypeId set to the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> representing the type ID |
| of the instance you want to create. If you do not pass in an object |
| type ID, an instance of ‘cmis:document’ will be created.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not yet supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>versioningState</li> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.createDocumentFromString"> |
| <code class="descname">createDocumentFromString</code><span class="sig-paren">(</span><em>name</em>, <em>properties={}</em>, <em>contentString=None</em>, <em>contentType=None</em>, <em>contentEncoding=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.createDocumentFromString" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new document setting the content to the string provided. If |
| the repository supports unfiled objects, you do not have to pass in |
| a parent <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> otherwise it is required.</p> |
| <p>This method is essentially a convenience method that wraps your string |
| with a StringIO and then calls createDocument.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">testFolder</span><span class="o">.</span><span class="n">createDocumentFromString</span><span class="p">(</span><span class="s1">'testdoc3'</span><span class="p">,</span> <span class="n">contentString</span><span class="o">=</span><span class="s1">'hello, world'</span><span class="p">,</span> <span class="n">contentType</span><span class="o">=</span><span class="s1">'text/plain'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.createFolder"> |
| <code class="descname">createFolder</code><span class="sig-paren">(</span><em>name</em>, <em>properties={}</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.createFolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> using the properties provided. |
| Right now I expect a property called ‘cmis:name’ but I don’t |
| complain if it isn’t there (although the CMIS provider will). If a |
| cmis:name property isn’t provided, the value passed in to the name |
| argument will be used.</p> |
| <p>To specify a custom folder type, pass in a property called |
| cmis:objectTypeId set to the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> representing the type ID |
| of the instance you want to create. If you do not pass in an object |
| type ID, an instance of ‘cmis:folder’ will be created.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">subFolder</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">createFolder</span><span class="p">(</span><span class="s1">'someSubfolder'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">subFolder</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> |
| <span class="go">u'someSubfolder'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.deleteTree"> |
| <code class="descname">deleteTree</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.deleteTree" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deletes the folder and all of its descendant objects.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">subFolder</span><span class="o">.</span><span class="n">getDescendants</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">2</span> |
| <span class="gp">>>> </span><span class="n">subFolder</span><span class="o">.</span><span class="n">deleteTree</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>allVersions</li> |
| <li>unfileObjects</li> |
| <li>continueOnFailure</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.getChildren"> |
| <code class="descname">getChildren</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.getChildren" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a paged <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a>. The result set contains a list of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects for each child of the Folder. The actual |
| type of the object returned depends on the object’s CMIS base type id. |
| For example, the method might return a list that contains both |
| <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> objects and <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> objects.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">childrenRS</span> <span class="o">=</span> <span class="n">subFolder</span><span class="o">.</span><span class="n">getChildren</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">children</span> <span class="o">=</span> <span class="n">childrenRS</span><span class="o">.</span><span class="n">getResults</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| <li>orderBy</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| <li>includePathSegment</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.getDescendants"> |
| <code class="descname">getDescendants</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.getDescendants" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the descendants of this folder. The descendants are returned as |
| a paged <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> object. The result set contains a list of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects where the actual type of each object |
| returned will vary depending on the object’s base type id. For example, |
| the method might return a list that contains both <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> |
| objects and <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> objects.</p> |
| <dl class="docutils"> |
| <dt>The following optional argument is supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>depth. Use depth=-1 for all descendants, which is the default if no |
| depth is specified.</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getDescendants</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">105</span> |
| <span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getDescendants</span><span class="p">(</span><span class="n">depth</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">103</span> |
| </pre></div> |
| </div> |
| <p>The following optional arguments <em>may</em> also work but haven’t been |
| tested:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| <li>includePathSegment</li> |
| </ul> |
| </div></blockquote> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.getParent"> |
| <code class="descname">getParent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.getParent" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The optional filter argument is not yet supported.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.getPaths"> |
| <code class="descname">getPaths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.getPaths" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the paths as a list of strings. The spec says folders cannot |
| be multi-filed, so this should always be one value. We return a list |
| to be symmetric with the same method in <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.getTree"> |
| <code class="descname">getTree</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.getTree" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Unlike <a class="reference internal" href="#cmislib.domain.Folder.getChildren" title="cmislib.domain.Folder.getChildren"><code class="xref py py-class docutils literal"><span class="pre">Folder.getChildren</span></code></a> or <a class="reference internal" href="#cmislib.domain.Folder.getDescendants" title="cmislib.domain.Folder.getDescendants"><code class="xref py py-class docutils literal"><span class="pre">Folder.getDescendants</span></code></a>, |
| this method returns only the descendant objects that are folders. The |
| results do not include the current folder.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first simple"> |
| <li>depth</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| <li>includePathSegment</li> |
| </ul> |
| <div class="last highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">getTree</span><span class="p">(</span><span class="n">depth</span><span class="o">=</span><span class="s1">'2'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">3</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">()</span><span class="o">.</span><span class="n">values</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="n">folder</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">u'subfolder2'</span> |
| <span class="go">u'parent test folder'</span> |
| <span class="go">u'subfolder'</span> |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Folder.removeObject"> |
| <code class="descname">removeObject</code><span class="sig-paren">(</span><em>cmisObject</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Folder.removeObject" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Removes the specified object from this folder. The repository must |
| support unfiling for this to work.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.ObjectType"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ObjectType</code><a class="headerlink" href="#cmislib.domain.ObjectType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents the CMIS object type such as ‘cmis:document’ or ‘cmis:folder’. |
| Contains metadata about the type.</p> |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.baseId"> |
| <code class="descname">baseId</code><a class="headerlink" href="#cmislib.domain.ObjectType.baseId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:baseId</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.controllableACL"> |
| <code class="descname">controllableACL</code><a class="headerlink" href="#cmislib.domain.ObjectType.controllableACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:controllableACL</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.controllablePolicy"> |
| <code class="descname">controllablePolicy</code><a class="headerlink" href="#cmislib.domain.ObjectType.controllablePolicy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:controllablePolicy</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.creatable"> |
| <code class="descname">creatable</code><a class="headerlink" href="#cmislib.domain.ObjectType.creatable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:creatable</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.description"> |
| <code class="descname">description</code><a class="headerlink" href="#cmislib.domain.ObjectType.description" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:description</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.displayName"> |
| <code class="descname">displayName</code><a class="headerlink" href="#cmislib.domain.ObjectType.displayName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:displayName</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.fileable"> |
| <code class="descname">fileable</code><a class="headerlink" href="#cmislib.domain.ObjectType.fileable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:fileable</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.fulltextIndexed"> |
| <code class="descname">fulltextIndexed</code><a class="headerlink" href="#cmislib.domain.ObjectType.fulltextIndexed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:fulltextIndexed</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getBaseId"> |
| <code class="descname">getBaseId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getBaseId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:baseId</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getDescription"> |
| <code class="descname">getDescription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getDescription" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:description</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getDisplayName"> |
| <code class="descname">getDisplayName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getDisplayName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:displayName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getLink"> |
| <code class="descname">getLink</code><span class="sig-paren">(</span><em>rel</em>, <em>linkType</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getLink" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the HREF for the link element with the specified rel and linkType.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">cmislib.atompub.atompub_binding</span> <span class="k">import</span> <span class="n">ATOM_XML_FEED_TYPE</span> |
| <span class="gp">>>> </span><span class="n">docType</span><span class="o">.</span><span class="n">getLink</span><span class="p">(</span><span class="s1">'down'</span><span class="p">,</span> <span class="n">ATOM_XML_FEED_TYPE</span><span class="p">)</span> |
| <span class="go">u'http://localhost:8080/alfresco/s/cmis/type/cmis:document/children'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getLocalName"> |
| <code class="descname">getLocalName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getLocalName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getLocalNamespace"> |
| <code class="descname">getLocalNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getLocalNamespace" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localNamespace</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getProperties"> |
| <code class="descname">getProperties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getProperties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.Property" title="cmislib.domain.Property"><code class="xref py py-class docutils literal"><span class="pre">Property</span></code></a> objects representing each property |
| defined for this type.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">objType</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinition</span><span class="p">(</span><span class="s1">'cmis:relationship'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">objType</span><span class="o">.</span><span class="n">properties</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Id:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">id</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Cardinality:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">cardinality</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Description:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">description</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Display name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">displayName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Local name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">localName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Local namespace:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">localNamespace</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Property type:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">propertyType</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Query name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">queryName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Updatability:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">updatability</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Inherited:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">inherited</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Orderable:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">orderable</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Queryable:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">queryable</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Required:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">required</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Open choice:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">openChoice</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getQueryName"> |
| <code class="descname">getQueryName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getQueryName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.getTypeId"> |
| <code class="descname">getTypeId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.getTypeId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the type ID for this object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">docType</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinition</span><span class="p">(</span><span class="s1">'cmis:document'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">docType</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="go">'cmis:document'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.id"> |
| <code class="descname">id</code><a class="headerlink" href="#cmislib.domain.ObjectType.id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the type ID for this object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">docType</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinition</span><span class="p">(</span><span class="s1">'cmis:document'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">docType</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="go">'cmis:document'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.includedInSupertypeQuery"> |
| <code class="descname">includedInSupertypeQuery</code><a class="headerlink" href="#cmislib.domain.ObjectType.includedInSupertypeQuery" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:includedInSupertypeQuery</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isControllableACL"> |
| <code class="descname">isControllableACL</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isControllableACL" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:controllableACL</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isControllablePolicy"> |
| <code class="descname">isControllablePolicy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isControllablePolicy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:controllablePolicy</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isCreatable"> |
| <code class="descname">isCreatable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isCreatable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:creatable</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isFileable"> |
| <code class="descname">isFileable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isFileable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:fileable</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isFulltextIndexed"> |
| <code class="descname">isFulltextIndexed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isFulltextIndexed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:fulltextIndexed</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isIncludedInSupertypeQuery"> |
| <code class="descname">isIncludedInSupertypeQuery</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isIncludedInSupertypeQuery" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:includedInSupertypeQuery</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.isQueryable"> |
| <code class="descname">isQueryable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.isQueryable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryable</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.localName"> |
| <code class="descname">localName</code><a class="headerlink" href="#cmislib.domain.ObjectType.localName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localName</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.localNamespace"> |
| <code class="descname">localNamespace</code><a class="headerlink" href="#cmislib.domain.ObjectType.localNamespace" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localNamespace</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#cmislib.domain.ObjectType.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.Property" title="cmislib.domain.Property"><code class="xref py py-class docutils literal"><span class="pre">Property</span></code></a> objects representing each property |
| defined for this type.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">objType</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinition</span><span class="p">(</span><span class="s1">'cmis:relationship'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">objType</span><span class="o">.</span><span class="n">properties</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Id:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">id</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Cardinality:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">cardinality</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Description:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">description</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Display name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">displayName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Local name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">localName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Local namespace:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">localNamespace</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Property type:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">propertyType</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Query name:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">queryName</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Updatability:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">updatability</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Inherited:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">inherited</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Orderable:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">orderable</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Queryable:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">queryable</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Required:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">required</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'Open choice:</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">prop</span><span class="o">.</span><span class="n">openChoice</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.queryName"> |
| <code class="descname">queryName</code><a class="headerlink" href="#cmislib.domain.ObjectType.queryName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryName</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.ObjectType.queryable"> |
| <code class="descname">queryable</code><a class="headerlink" href="#cmislib.domain.ObjectType.queryable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryable</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ObjectType.reload"> |
| <code class="descname">reload</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ObjectType.reload" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This method will reload the object’s data from the CMIS service.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Policy"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Policy</code><a class="headerlink" href="#cmislib.domain.Policy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>An arbirary object that can ‘applied’ to objects that the |
| repository identifies as being ‘controllable’.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Property"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Property</code><a class="headerlink" href="#cmislib.domain.Property" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This class represents an attribute or property definition of an object |
| type.</p> |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.cardinality"> |
| <code class="descname">cardinality</code><a class="headerlink" href="#cmislib.domain.Property.cardinality" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:cardinality</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.description"> |
| <code class="descname">description</code><a class="headerlink" href="#cmislib.domain.Property.description" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:description</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.displayName"> |
| <code class="descname">displayName</code><a class="headerlink" href="#cmislib.domain.Property.displayName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:displayName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getCardinality"> |
| <code class="descname">getCardinality</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getCardinality" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:cardinality</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getDescription"> |
| <code class="descname">getDescription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getDescription" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:description</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getDisplayName"> |
| <code class="descname">getDisplayName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getDisplayName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:displayName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getId"> |
| <code class="descname">getId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:id</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getLocalName"> |
| <code class="descname">getLocalName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getLocalName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getLocalNamespace"> |
| <code class="descname">getLocalNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getLocalNamespace" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localNamespace</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getPropertyType"> |
| <code class="descname">getPropertyType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getPropertyType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:propertyType</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getQueryName"> |
| <code class="descname">getQueryName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getQueryName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryName</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.getUpdatability"> |
| <code class="descname">getUpdatability</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.getUpdatability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:updatability</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.id"> |
| <code class="descname">id</code><a class="headerlink" href="#cmislib.domain.Property.id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:id</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.inherited"> |
| <code class="descname">inherited</code><a class="headerlink" href="#cmislib.domain.Property.inherited" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:inherited</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.isInherited"> |
| <code class="descname">isInherited</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.isInherited" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:inherited</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.isOpenChoice"> |
| <code class="descname">isOpenChoice</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.isOpenChoice" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:openChoice</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.isOrderable"> |
| <code class="descname">isOrderable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.isOrderable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:orderable</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.isQueryable"> |
| <code class="descname">isQueryable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.isQueryable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryable</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Property.isRequired"> |
| <code class="descname">isRequired</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Property.isRequired" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:required</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.localName"> |
| <code class="descname">localName</code><a class="headerlink" href="#cmislib.domain.Property.localName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localName</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.localNamespace"> |
| <code class="descname">localNamespace</code><a class="headerlink" href="#cmislib.domain.Property.localNamespace" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:localNamespace</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.openChoice"> |
| <code class="descname">openChoice</code><a class="headerlink" href="#cmislib.domain.Property.openChoice" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:openChoice</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.orderable"> |
| <code class="descname">orderable</code><a class="headerlink" href="#cmislib.domain.Property.orderable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:orderable</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.propertyType"> |
| <code class="descname">propertyType</code><a class="headerlink" href="#cmislib.domain.Property.propertyType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:propertyType</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.queryName"> |
| <code class="descname">queryName</code><a class="headerlink" href="#cmislib.domain.Property.queryName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryName</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.queryable"> |
| <code class="descname">queryable</code><a class="headerlink" href="#cmislib.domain.Property.queryable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:queryable</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.required"> |
| <code class="descname">required</code><a class="headerlink" href="#cmislib.domain.Property.required" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:required</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Property.updatability"> |
| <code class="descname">updatability</code><a class="headerlink" href="#cmislib.domain.Property.updatability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for cmis:updatability</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Relationship"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Relationship</code><a class="headerlink" href="#cmislib.domain.Relationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Defines a relationship object between two <code class="xref py py-class docutils literal"><span class="pre">CmisObjects</span></code> objects</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.Relationship.getSource"> |
| <code class="descname">getSource</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Relationship.getSource" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an instance of the appropriate child-type of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> |
| for the source side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Relationship.getSourceId"> |
| <code class="descname">getSourceId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Relationship.getSourceId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> on the source side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Relationship.getTarget"> |
| <code class="descname">getTarget</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Relationship.getTarget" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an instance of the appropriate child-type of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> |
| for the target side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Relationship.getTargetId"> |
| <code class="descname">getTargetId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Relationship.getTargetId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> on the target side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Relationship.source"> |
| <code class="descname">source</code><a class="headerlink" href="#cmislib.domain.Relationship.source" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an instance of the appropriate child-type of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> |
| for the source side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Relationship.sourceId"> |
| <code class="descname">sourceId</code><a class="headerlink" href="#cmislib.domain.Relationship.sourceId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> on the source side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Relationship.target"> |
| <code class="descname">target</code><a class="headerlink" href="#cmislib.domain.Relationship.target" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an instance of the appropriate child-type of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> |
| for the target side of the relationship.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Relationship.targetId"> |
| <code class="descname">targetId</code><a class="headerlink" href="#cmislib.domain.Relationship.targetId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the <a class="reference internal" href="#cmislib.domain.CmisId" title="cmislib.domain.CmisId"><code class="xref py py-class docutils literal"><span class="pre">CmisId</span></code></a> on the target side of the relationship.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Rendition"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Rendition</code><a class="headerlink" href="#cmislib.domain.Rendition" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This class represents a Rendition.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getHeight"> |
| <code class="descname">getHeight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getHeight" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s height</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getHref"> |
| <code class="descname">getHref</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getHref" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s href</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getKind"> |
| <code class="descname">getKind</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getKind" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s kind</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getLength"> |
| <code class="descname">getLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getLength" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s length</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getMimeType"> |
| <code class="descname">getMimeType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getMimeType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the rendition’s mime type</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getRenditionDocumentId"> |
| <code class="descname">getRenditionDocumentId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getRenditionDocumentId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s width</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getStreamId"> |
| <code class="descname">getStreamId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getStreamId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the rendition’s stream ID</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getTitle"> |
| <code class="descname">getTitle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getTitle" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s title</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Rendition.getWidth"> |
| <code class="descname">getWidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Rendition.getWidth" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s width</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.height"> |
| <code class="descname">height</code><a class="headerlink" href="#cmislib.domain.Rendition.height" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s height</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.href"> |
| <code class="descname">href</code><a class="headerlink" href="#cmislib.domain.Rendition.href" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s href</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.kind"> |
| <code class="descname">kind</code><a class="headerlink" href="#cmislib.domain.Rendition.kind" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s kind</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.length"> |
| <code class="descname">length</code><a class="headerlink" href="#cmislib.domain.Rendition.length" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s length</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.mimeType"> |
| <code class="descname">mimeType</code><a class="headerlink" href="#cmislib.domain.Rendition.mimeType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the rendition’s mime type</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.renditionDocumentId"> |
| <code class="descname">renditionDocumentId</code><a class="headerlink" href="#cmislib.domain.Rendition.renditionDocumentId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s width</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.streamId"> |
| <code class="descname">streamId</code><a class="headerlink" href="#cmislib.domain.Rendition.streamId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the rendition’s stream ID</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.title"> |
| <code class="descname">title</code><a class="headerlink" href="#cmislib.domain.Rendition.title" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s title</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Rendition.width"> |
| <code class="descname">width</code><a class="headerlink" href="#cmislib.domain.Rendition.width" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Getter for the renditions’s width</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.Repository"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">Repository</code><span class="sig-paren">(</span><em>cmisClient</em>, <em>xmlDoc=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents a CMIS repository. Will lazily populate itself by |
| calling the repository CMIS service URL.</p> |
| <p>You must pass in an instance of a CmisClient when creating an |
| instance of this class.</p> |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.capabilities"> |
| <code class="descname">capabilities</code><a class="headerlink" href="#cmislib.domain.Repository.capabilities" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of repository capabilities.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">caps</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCapabilities</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">caps</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> |
| <span class="gp">...</span> |
| <span class="go">PWCUpdatable:True</span> |
| <span class="go">VersionSpecificFiling:False</span> |
| <span class="go">Join:None</span> |
| <span class="go">ContentStreamUpdatability:anytime</span> |
| <span class="go">AllVersionsSearchable:False</span> |
| <span class="go">Renditions:None</span> |
| <span class="go">Multifiling:True</span> |
| <span class="go">GetFolderTree:True</span> |
| <span class="go">GetDescendants:True</span> |
| <span class="go">ACL:None</span> |
| <span class="go">PWCSearchable:True</span> |
| <span class="go">Query:bothcombined</span> |
| <span class="go">Unfiling:False</span> |
| <span class="go">Changes:None</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createDocument"> |
| <code class="descname">createDocument</code><span class="sig-paren">(</span><em>name</em>, <em>properties={}</em>, <em>parentFolder=None</em>, <em>contentFile=None</em>, <em>contentType=None</em>, <em>contentEncoding=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createDocument" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new <a class="reference internal" href="#cmislib.domain.Document" title="cmislib.domain.Document"><code class="xref py py-class docutils literal"><span class="pre">Document</span></code></a> object. If the repository |
| supports unfiled objects, you do not have to pass in |
| a parent <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> otherwise it is required.</p> |
| <p>To create a document with an associated contentFile, pass in a |
| File object. The method will attempt to guess the appropriate content |
| type and encoding based on the file. To specify it yourself, pass them |
| in via the contentType and contentEncoding arguments.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'sample-a.pdf'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">folder</span><span class="o">.</span><span class="n">createDocument</span><span class="p">(</span><span class="s1">'sample-a.pdf'</span><span class="p">,</span> <span class="n">contentFile</span><span class="o">=</span><span class="n">f</span><span class="p">)</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x105be5e10></span> |
| <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="go">u'sample-a.pdf'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not currently supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>versioningState</li> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createDocumentFromSource"> |
| <code class="descname">createDocumentFromSource</code><span class="sig-paren">(</span><em>sourceId</em>, <em>properties={}</em>, <em>parentFolder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createDocumentFromSource" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is not yet implemented.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not yet supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>versioningState</li> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createDocumentFromString"> |
| <code class="descname">createDocumentFromString</code><span class="sig-paren">(</span><em>name</em>, <em>properties={}</em>, <em>parentFolder=None</em>, <em>contentString=None</em>, <em>contentType=None</em>, <em>contentEncoding=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createDocumentFromString" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new document setting the content to the string provided. If |
| the repository supports unfiled objects, you do not have to pass in |
| a parent <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> otherwise it is required.</p> |
| <p>This method is essentially a convenience method that wraps your string |
| with a StringIO and then calls createDocument.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">createDocumentFromString</span><span class="p">(</span><span class="s1">'testdoc5'</span><span class="p">,</span> <span class="n">parentFolder</span><span class="o">=</span><span class="n">testFolder</span><span class="p">,</span> <span class="n">contentString</span><span class="o">=</span><span class="s1">'Hello, World!'</span><span class="p">,</span> <span class="n">contentType</span><span class="o">=</span><span class="s1">'text/plain'</span><span class="p">)</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x101352ed0></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createFolder"> |
| <code class="descname">createFolder</code><span class="sig-paren">(</span><em>parentFolder</em>, <em>name</em>, <em>properties={}</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createFolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> object in the specified parentFolder.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">root</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getRootFolder</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">folder</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">createFolder</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="s1">'someFolder2'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="go">u'someFolder2'</span> |
| <span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/2224a63c-350b-438c-be72-8f425e79ce1f'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not yet supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createPolicy"> |
| <code class="descname">createPolicy</code><span class="sig-paren">(</span><em>properties</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createPolicy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This has not yet been implemented.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not currently supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>folderId</li> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.createRelationship"> |
| <code class="descname">createRelationship</code><span class="sig-paren">(</span><em>sourceObj</em>, <em>targetObj</em>, <em>relType</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.createRelationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a relationship of the specific type between a source object |
| and a target object and returns the new <a class="reference internal" href="#cmislib.domain.Relationship" title="cmislib.domain.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> object.</p> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not currently supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>policies</li> |
| <li>addACEs</li> |
| <li>removeACEs</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getCapabilities"> |
| <code class="descname">getCapabilities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getCapabilities" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of repository capabilities.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">caps</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCapabilities</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">caps</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> |
| <span class="gp">...</span> |
| <span class="go">PWCUpdatable:True</span> |
| <span class="go">VersionSpecificFiling:False</span> |
| <span class="go">Join:None</span> |
| <span class="go">ContentStreamUpdatability:anytime</span> |
| <span class="go">AllVersionsSearchable:False</span> |
| <span class="go">Renditions:None</span> |
| <span class="go">Multifiling:True</span> |
| <span class="go">GetFolderTree:True</span> |
| <span class="go">GetDescendants:True</span> |
| <span class="go">ACL:None</span> |
| <span class="go">PWCSearchable:True</span> |
| <span class="go">Query:bothcombined</span> |
| <span class="go">Unfiling:False</span> |
| <span class="go">Changes:None</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getCheckedOutDocs"> |
| <code class="descname">getCheckedOutDocs</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getCheckedOutDocs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a ResultSet of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects that |
| are currently checked out.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCheckedOutDocs</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">2</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCheckedOutDocs</span><span class="p">()</span><span class="o">.</span><span class="n">getResults</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="n">doc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">u'sample-a (Working Copy).pdf'</span> |
| <span class="go">u'sample-b (Working Copy).pdf'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>These optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>folderId</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| <li>orderBy</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getCollection"> |
| <code class="descname">getCollection</code><span class="sig-paren">(</span><em>collectionType</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getCollection" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of objects returned for the specified collection.</p> |
| <p>If the query collection is requested, an exception will be raised. |
| That collection isn’t meant to be retrieved.</p> |
| <p>If the types collection is specified, the method returns the result of |
| <cite>getTypeDefinitions</cite> and ignores any optional params passed in.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">cmislib.atompub.atompub_binding</span> <span class="k">import</span> <span class="n">TYPES_COLL</span> |
| <span class="gp">>>> </span><span class="n">types</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCollection</span><span class="p">(</span><span class="n">TYPES_COLL</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">types</span><span class="p">)</span> |
| <span class="go">4</span> |
| <span class="gp">>>> </span><span class="n">types</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="go">u'cmis:folder'</span> |
| </pre></div> |
| </div> |
| <p>Otherwise, the collection URL is invoked, and a <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> is |
| returned.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">cmislib.atompub.atompub_binding</span> <span class="k">import</span> <span class="n">CHECKED_OUT_COLL</span> |
| <span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCollection</span><span class="p">(</span><span class="n">CHECKED_OUT_COLL</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">1</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getContentChanges"> |
| <code class="descname">getContentChanges</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getContentChanges" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a <a class="reference internal" href="#cmislib.domain.ResultSet" title="cmislib.domain.ResultSet"><code class="xref py py-class docutils literal"><span class="pre">ResultSet</span></code></a> containing <a class="reference internal" href="#cmislib.domain.ChangeEntry" title="cmislib.domain.ChangeEntry"><code class="xref py py-class docutils literal"><span class="pre">ChangeEntry</span></code></a> objects.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">changeEntry</span> <span class="ow">in</span> <span class="n">rs</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">objectId</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">id</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">changeType</span> |
| <span class="gp">... </span> <span class="n">changeEntry</span><span class="o">.</span><span class="n">changeTime</span> |
| <span class="gp">...</span> |
| <span class="go">'workspace://SpacesStore/0e2dc775-16b7-4634-9e54-2417a196829b'</span> |
| <span class="go">u'urn:uuid:0e2dc775-16b7-4634-9e54-2417a196829b'</span> |
| <span class="go">u'created'</span> |
| <span class="go">datetime.datetime(2010, 2, 11, 12, 55, 14)</span> |
| <span class="go">'workspace://SpacesStore/bd768f9f-99a7-4033-828d-5b13f96c6923'</span> |
| <span class="go">u'urn:uuid:bd768f9f-99a7-4033-828d-5b13f96c6923'</span> |
| <span class="go">u'updated'</span> |
| <span class="go">datetime.datetime(2010, 2, 11, 12, 55, 13)</span> |
| <span class="go">'workspace://SpacesStore/572c2cac-6b26-4cd8-91ad-b2931fe5b3fb'</span> |
| <span class="go">u'urn:uuid:572c2cac-6b26-4cd8-91ad-b2931fe5b3fb'</span> |
| <span class="go">u'updated'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>changeLogToken</li> |
| <li>includeProperties</li> |
| <li>includePolicyIDs</li> |
| <li>includeACL</li> |
| <li>maxItems</li> |
| </ul> |
| </dd> |
| </dl> |
| <p>You can get the latest change log token by inspecting the repository |
| info via <a class="reference internal" href="#cmislib.domain.Repository.getRepositoryInfo" title="cmislib.domain.Repository.getRepositoryInfo"><code class="xref py py-meth docutils literal"><span class="pre">Repository.getRepositoryInfo()</span></code></a>.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s1">'latestChangeLogToken'</span><span class="p">]</span> |
| <span class="go">u'2692'</span> |
| <span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getContentChanges</span><span class="p">(</span><span class="n">changeLogToken</span><span class="o">=</span><span class="s1">'2692'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="p">)</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="n">rs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">id</span> |
| <span class="go">u'urn:uuid:8e88f694-93ef-44c5-9f70-f12fff824be9'</span> |
| <span class="gp">>>> </span><span class="n">rs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">changeType</span> |
| <span class="go">u'updated'</span> |
| <span class="gp">>>> </span><span class="n">rs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">changeTime</span> |
| <span class="go">datetime.datetime(2010, 2, 16, 20, 6, 37)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getFolder"> |
| <code class="descname">getFolder</code><span class="sig-paren">(</span><em>folderId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getFolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a <a class="reference internal" href="#cmislib.domain.Folder" title="cmislib.domain.Folder"><code class="xref py py-class docutils literal"><span class="pre">Folder</span></code></a> object for a specified folderId</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">someFolder</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getFolder</span><span class="p">(</span><span class="s1">'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">someFolder</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getLink"> |
| <code class="descname">getLink</code><span class="sig-paren">(</span><em>rel</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getLink" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the HREF attribute of an Atom link element for the |
| specified rel.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getObject"> |
| <code class="descname">getObject</code><span class="sig-paren">(</span><em>objectId</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getObject" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an object given the specified object ID.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObject</span><span class="p">(</span><span class="s1">'workspace://SpacesStore/f0c8b90f-bec0-4405-8b9c-2ab570589808'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="go">u'sample-b.pdf'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>returnVersion</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>includePolicyIds</li> |
| <li>renditionFilter</li> |
| <li>includeACL</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getObjectByPath"> |
| <code class="descname">getObjectByPath</code><span class="sig-paren">(</span><em>path</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getObjectByPath" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an object given the path to the object.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">'/jeff test/sample-b.pdf'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="go">u'sample-b.pdf'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are not currently supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>filter</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getPermissionDefinitions"> |
| <code class="descname">getPermissionDefinitions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getPermissionDefinitions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of permission definitions for this repository. The |
| key is the permission string or technical name of the permission |
| and the value is the permission description.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">permDef</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">permissionDefinitions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">permDef</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.LinkChildren</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}folder.Consumer</span> |
| <span class="go">{http://www.alfresco.org/model/security/1.0}All.All</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateAssociations</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.FullControl</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.AddChildren</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.ReadAssociations</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}folder.Editor</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}cmobject.Editor</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.DeleteAssociations</span> |
| <span class="go">cmis:read</span> |
| <span class="go">cmis:write</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getPermissionMap"> |
| <code class="descname">getPermissionMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getPermissionMap" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary representing the permission mapping table where |
| each key is a permission key string and each value is a list of one or |
| more permissions the principal must have to perform the operation.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">permissionMap</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'To do this: </span><span class="si">%s</span><span class="s1">, you must have these perms:'</span> <span class="o">%</span> <span class="n">k</span> |
| <span class="gp">... </span> <span class="k">for</span> <span class="n">perm</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">perm</span> |
| <span class="gp">...</span> |
| <span class="go">To do this: canCreateFolder.Folder, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateChildren</span> |
| <span class="go">To do this: canAddToFolder.Folder, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateChildren</span> |
| <span class="go">To do this: canDelete.Object, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.DeleteNode</span> |
| <span class="go">To do this: canCheckin.Document, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}lockable.CheckIn</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getPropagation"> |
| <code class="descname">getPropagation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getPropagation" title="Permalink to this definition">¶</a></dt> |
| <dd><dl class="docutils"> |
| <dt>Returns the value of the cmis:propagation element. Valid values are:</dt> |
| <dd><ul class="first last simple"> |
| <li>objectonly: indicates that the repository is able to apply ACEs |
| without changing the ACLs of other objects</li> |
| <li>propagate: indicates that the repository is able to apply ACEs to a |
| given object and propagate this change to all inheriting objects</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">propagation</span> |
| <span class="go">u'propagate'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getRepositoryId"> |
| <code class="descname">getRepositoryId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getRepositoryId" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns this repository’s unique identifier</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryId</span><span class="p">()</span> |
| <span class="go">u'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getRepositoryInfo"> |
| <code class="descname">getRepositoryInfo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getRepositoryInfo" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of repository information.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span><span class="o">>>></span> <span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryName</span><span class="p">()</span> |
| <span class="go">u'Main Repository'</span> |
| <span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryInfo</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">info</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> |
| <span class="gp">...</span> |
| <span class="go">cmisSpecificationTitle:Version 1.0 Committee Draft 04</span> |
| <span class="go">cmisVersionSupported:1.0</span> |
| <span class="go">repositoryDescription:None</span> |
| <span class="go">productVersion:3.2.0 (r2 2440)</span> |
| <span class="go">rootFolderId:workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348</span> |
| <span class="go">repositoryId:83beb297-a6fa-4ac5-844b-98c871c0eea9</span> |
| <span class="go">repositoryName:Main Repository</span> |
| <span class="go">vendorName:Alfresco</span> |
| <span class="go">productName:Alfresco Repository (Community)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getRepositoryName"> |
| <code class="descname">getRepositoryName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getRepositoryName" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns this repository’s name</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryName</span><span class="p">()</span> |
| <span class="go">u'Main Repository'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getRootFolder"> |
| <code class="descname">getRootFolder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getRootFolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the root folder of the repository</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">root</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getRootFolder</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">root</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getSupportedPermissions"> |
| <code class="descname">getSupportedPermissions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getSupportedPermissions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of the cmis:supportedPermissions element. Valid |
| values are:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>basic: indicates that the CMIS Basic permissions are supported</li> |
| <li>repository: indicates that repository specific permissions are supported</li> |
| <li>both: indicates that both CMIS basic permissions and repository specific permissions are supported</li> |
| </ul> |
| </div></blockquote> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">supportedPermissions</span> |
| <span class="go">u'both'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getTypeChildren"> |
| <code class="descname">getTypeChildren</code><span class="sig-paren">(</span><em>typeId=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getTypeChildren" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.ObjectType" title="cmislib.domain.ObjectType"><code class="xref py py-class docutils literal"><span class="pre">ObjectType</span></code></a> objects corresponding to the |
| child types of the type specified by the typeId.</p> |
| <p>If no typeId is provided, the result will be the same as calling |
| <cite>self.getTypeDefinitions</cite></p> |
| <dl class="docutils"> |
| <dt>These optional arguments are current unsupported:</dt> |
| <dd><ul class="first last simple"> |
| <li>includePropertyDefinitions</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">baseTypes</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeChildren</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">baseType</span> <span class="ow">in</span> <span class="n">baseTypes</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">baseType</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:folder</span> |
| <span class="go">cmis:relationship</span> |
| <span class="go">cmis:document</span> |
| <span class="go">cmis:policy</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getTypeDefinition"> |
| <code class="descname">getTypeDefinition</code><span class="sig-paren">(</span><em>typeId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getTypeDefinition" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an <a class="reference internal" href="#cmislib.domain.ObjectType" title="cmislib.domain.ObjectType"><code class="xref py py-class docutils literal"><span class="pre">ObjectType</span></code></a> object for the specified object type id.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">folderType</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinition</span><span class="p">(</span><span class="s1">'cmis:folder'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getTypeDefinitions"> |
| <code class="descname">getTypeDefinitions</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getTypeDefinitions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.ObjectType" title="cmislib.domain.ObjectType"><code class="xref py py-class docutils literal"><span class="pre">ObjectType</span></code></a> objects representing |
| the base types in the repository.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">baseTypes</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDefinitions</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">baseType</span> <span class="ow">in</span> <span class="n">baseTypes</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">baseType</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:folder</span> |
| <span class="go">cmis:relationship</span> |
| <span class="go">cmis:document</span> |
| <span class="go">cmis:policy</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getTypeDescendants"> |
| <code class="descname">getTypeDescendants</code><span class="sig-paren">(</span><em>typeId=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getTypeDescendants" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.ObjectType" title="cmislib.domain.ObjectType"><code class="xref py py-class docutils literal"><span class="pre">ObjectType</span></code></a> objects corresponding to the |
| descendant types of the type specified by the typeId.</p> |
| <p>If no typeId is provided, the repository’s “typesdescendants” URL |
| will be called to determine the list of descendant types.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">allTypes</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDescendants</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">aType</span> <span class="ow">in</span> <span class="n">allTypes</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">aType</span><span class="o">.</span><span class="n">getTypeId</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:folder</span> |
| <span class="go">F:cm:systemfolder</span> |
| <span class="go">F:act:savedactionfolder</span> |
| <span class="go">F:app:configurations</span> |
| <span class="go">F:fm:forums</span> |
| <span class="go">F:wcm:avmfolder</span> |
| <span class="go">F:wcm:avmplainfolder</span> |
| <span class="go">F:wca:webfolder</span> |
| <span class="go">F:wcm:avmlayeredfolder</span> |
| <span class="go">F:st:site</span> |
| <span class="go">F:app:glossary</span> |
| <span class="go">F:fm:topic</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>These optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>depth</li> |
| <li>includePropertyDefinitions</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">types</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDescendants</span><span class="p">(</span><span class="s1">'cmis:folder'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">types</span><span class="p">)</span> |
| <span class="go">17</span> |
| <span class="gp">>>> </span><span class="n">types</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDescendants</span><span class="p">(</span><span class="s1">'cmis:folder'</span><span class="p">,</span> <span class="n">depth</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">types</span><span class="p">)</span> |
| <span class="go">12</span> |
| <span class="gp">>>> </span><span class="n">types</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getTypeDescendants</span><span class="p">(</span><span class="s1">'cmis:folder'</span><span class="p">,</span> <span class="n">depth</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">types</span><span class="p">)</span> |
| <span class="go">17</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.getUnfiledDocs"> |
| <code class="descname">getUnfiledDocs</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.getUnfiledDocs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a ResultSet of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects that |
| are currently unfiled.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getUnfiledDocs</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">2</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">getUnfiledDocs</span><span class="p">()</span><span class="o">.</span><span class="n">getResults</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="n">doc</span><span class="o">.</span><span class="n">getTitle</span><span class="p">()</span> |
| <span class="gp">...</span> |
| <span class="go">u'sample-a.pdf'</span> |
| <span class="go">u'sample-b.pdf'</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>These optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>folderId</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| <li>orderBy</li> |
| <li>filter</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.id"> |
| <code class="descname">id</code><a class="headerlink" href="#cmislib.domain.Repository.id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns this repository’s unique identifier</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryId</span><span class="p">()</span> |
| <span class="go">u'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.info"> |
| <code class="descname">info</code><a class="headerlink" href="#cmislib.domain.Repository.info" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dict of repository information.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span><span class="o">>>></span> <span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryName</span><span class="p">()</span> |
| <span class="go">u'Main Repository'</span> |
| <span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryInfo</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">info</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> |
| <span class="gp">...</span> |
| <span class="go">cmisSpecificationTitle:Version 1.0 Committee Draft 04</span> |
| <span class="go">cmisVersionSupported:1.0</span> |
| <span class="go">repositoryDescription:None</span> |
| <span class="go">productVersion:3.2.0 (r2 2440)</span> |
| <span class="go">rootFolderId:workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348</span> |
| <span class="go">repositoryId:83beb297-a6fa-4ac5-844b-98c871c0eea9</span> |
| <span class="go">repositoryName:Main Repository</span> |
| <span class="go">vendorName:Alfresco</span> |
| <span class="go">productName:Alfresco Repository (Community)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.name"> |
| <code class="descname">name</code><a class="headerlink" href="#cmislib.domain.Repository.name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns this repository’s name</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">getDefaultRepository</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">getRepositoryName</span><span class="p">()</span> |
| <span class="go">u'Main Repository'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.permissionDefinitions"> |
| <code class="descname">permissionDefinitions</code><a class="headerlink" href="#cmislib.domain.Repository.permissionDefinitions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary of permission definitions for this repository. The |
| key is the permission string or technical name of the permission |
| and the value is the permission description.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="n">permDef</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">permissionDefinitions</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">permDef</span> |
| <span class="gp">...</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.LinkChildren</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}folder.Consumer</span> |
| <span class="go">{http://www.alfresco.org/model/security/1.0}All.All</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateAssociations</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.FullControl</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.AddChildren</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.ReadAssociations</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}folder.Editor</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}cmobject.Editor</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.DeleteAssociations</span> |
| <span class="go">cmis:read</span> |
| <span class="go">cmis:write</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.permissionMap"> |
| <code class="descname">permissionMap</code><a class="headerlink" href="#cmislib.domain.Repository.permissionMap" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary representing the permission mapping table where |
| each key is a permission key string and each value is a list of one or |
| more permissions the principal must have to perform the operation.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">repo</span><span class="o">.</span><span class="n">permissionMap</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="s1">'To do this: </span><span class="si">%s</span><span class="s1">, you must have these perms:'</span> <span class="o">%</span> <span class="n">k</span> |
| <span class="gp">... </span> <span class="k">for</span> <span class="n">perm</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="nb">print</span> <span class="n">perm</span> |
| <span class="gp">...</span> |
| <span class="go">To do this: canCreateFolder.Folder, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateChildren</span> |
| <span class="go">To do this: canAddToFolder.Folder, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.CreateChildren</span> |
| <span class="go">To do this: canDelete.Object, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/system/1.0}base.DeleteNode</span> |
| <span class="go">To do this: canCheckin.Document, you must have these perms:</span> |
| <span class="go">cmis:all</span> |
| <span class="go">{http://www.alfresco.org/model/content/1.0}lockable.CheckIn</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.propagation"> |
| <code class="descname">propagation</code><a class="headerlink" href="#cmislib.domain.Repository.propagation" title="Permalink to this definition">¶</a></dt> |
| <dd><dl class="docutils"> |
| <dt>Returns the value of the cmis:propagation element. Valid values are:</dt> |
| <dd><ul class="first last simple"> |
| <li>objectonly: indicates that the repository is able to apply ACEs |
| without changing the ACLs of other objects</li> |
| <li>propagate: indicates that the repository is able to apply ACEs to a |
| given object and propagate this change to all inheriting objects</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">propagation</span> |
| <span class="go">u'propagate'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.query"> |
| <code class="descname">query</code><span class="sig-paren">(</span><em>statement</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.query" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects based on the CMIS |
| Query Language passed in as the statement. The actual objects |
| returned will be instances of the appropriate child class based |
| on the object’s base type ID.</p> |
| <p>In order for the results to be properly instantiated as objects, |
| make sure you include ‘cmis:objectId’ as one of the fields in |
| your select statement, or just use “SELECT *”.</p> |
| <p>If you want the search results to automatically be instantiated with |
| the appropriate sub-class of <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> you must either |
| include cmis:baseTypeId as one of the fields in your select statement |
| or just use “SELECT *”.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">q</span> <span class="o">=</span> <span class="s2">"select * from cmis:document where cmis:name like '%test%'"</span> |
| <span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">q</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasNext</span><span class="p">()</span> |
| <span class="go">False</span> |
| </pre></div> |
| </div> |
| <dl class="docutils"> |
| <dt>The following optional arguments are supported:</dt> |
| <dd><ul class="first last simple"> |
| <li>searchAllVersions</li> |
| <li>includeRelationships</li> |
| <li>renditionFilter</li> |
| <li>includeAllowableActions</li> |
| <li>maxItems</li> |
| <li>skipCount</li> |
| </ul> |
| </dd> |
| </dl> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">q</span> <span class="o">=</span> <span class="s1">'select * from cmis:document'</span> |
| <span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">q</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">148</span> |
| <span class="gp">>>> </span><span class="n">rs</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">maxItems</span><span class="o">=</span><span class="s1">'5'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">rs</span><span class="o">.</span><span class="n">getResults</span><span class="p">())</span> |
| <span class="go">5</span> |
| <span class="gp">>>> </span><span class="n">rs</span><span class="o">.</span><span class="n">hasNext</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.Repository.reload"> |
| <code class="descname">reload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.Repository.reload" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This method will re-fetch the repository’s XML data from the CMIS |
| repository.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.rootFolder"> |
| <code class="descname">rootFolder</code><a class="headerlink" href="#cmislib.domain.Repository.rootFolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the root folder of the repository</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">root</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getRootFolder</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">root</span><span class="o">.</span><span class="n">getObjectId</span><span class="p">()</span> |
| <span class="go">u'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="cmislib.domain.Repository.supportedPermissions"> |
| <code class="descname">supportedPermissions</code><a class="headerlink" href="#cmislib.domain.Repository.supportedPermissions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the value of the cmis:supportedPermissions element. Valid |
| values are:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>basic: indicates that the CMIS Basic permissions are supported</li> |
| <li>repository: indicates that repository specific permissions are supported</li> |
| <li>both: indicates that both CMIS basic permissions and repository specific permissions are supported</li> |
| </ul> |
| </div></blockquote> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">repo</span><span class="o">.</span><span class="n">supportedPermissions</span> |
| <span class="go">u'both'</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="cmislib.domain.ResultSet"> |
| <em class="property">class </em><code class="descclassname">cmislib.domain.</code><code class="descname">ResultSet</code><a class="headerlink" href="#cmislib.domain.ResultSet" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents a paged result set. In CMIS, this is most often an Atom feed.</p> |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.getFirst"> |
| <code class="descname">getFirst</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.getFirst" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the first page of results as a dictionary of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects or its appropriate sub-type. This only |
| works when the server returns a “first” link. Not all of them do.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasFirst</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">results</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getFirst</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">result</span> |
| <span class="gp">...</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10480bc90></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.getLast"> |
| <code class="descname">getLast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.getLast" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the last page of results as a dictionary of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects or its appropriate sub-type. This only |
| works when the server is returning a “last” link. Not all of them do.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasLast</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">results</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getLast</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">result</span> |
| <span class="gp">...</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10480bc90></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.getNext"> |
| <code class="descname">getNext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.getNext" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the next page of results as a dictionary of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects or its appropriate sub-type.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasNext</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">results</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getNext</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">result</span> |
| <span class="gp">...</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10480bc90></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.getPrev"> |
| <code class="descname">getPrev</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.getPrev" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the prev page of results as a dictionary of |
| <a class="reference internal" href="#cmislib.domain.CmisObject" title="cmislib.domain.CmisObject"><code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code></a> objects or its appropriate sub-type. This only |
| works when the server returns a “prev” link. Not all of them do.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasPrev</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">results</span> <span class="o">=</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getPrev</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span> |
| <span class="gp">... </span> <span class="n">result</span> |
| <span class="gp">...</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x10480bc90></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.getResults"> |
| <code class="descname">getResults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.getResults" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the results that were fetched and cached by the get*Page call.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getCheckedOutDocs</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasNext</span><span class="p">()</span> |
| <span class="go">False</span> |
| <span class="gp">>>> </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">resultSet</span><span class="o">.</span><span class="n">getResults</span><span class="p">():</span> |
| <span class="gp">... </span> <span class="n">result</span> |
| <span class="gp">...</span> |
| <span class="go"><cmislib.atompub.binding.AtomPubDocument object at 0x104851810></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.hasFirst"> |
| <code class="descname">hasFirst</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.hasFirst" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if this page contains a first link. Not all CMIS providers |
| implement first links consistently.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasFirst</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.hasLast"> |
| <code class="descname">hasLast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.hasLast" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if this page contains a last link. Not all CMIS providers |
| implement last links consistently.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasLast</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.hasNext"> |
| <code class="descname">hasNext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.hasNext" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if this page contains a next link.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasNext</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.hasObject"> |
| <code class="descname">hasObject</code><span class="sig-paren">(</span><em>objectId</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.hasObject" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if the specified objectId is found in the list of results, |
| otherwise returns False.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.hasPrev"> |
| <code class="descname">hasPrev</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.hasPrev" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if this page contains a prev link. Not all CMIS providers |
| implement prev links consistently.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">hasPrev</span><span class="p">()</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.domain.ResultSet.reload"> |
| <code class="descname">reload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.domain.ResultSet.reload" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Re-invokes the self link for the current set of results.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">resultSet</span><span class="o">.</span><span class="n">reload</span><span class="p">()</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="the-cmislib-net-module"> |
| <h2>The <a class="reference internal" href="#module-cmislib.net" title="cmislib.net"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.net</span></code></a> Module<a class="headerlink" href="#the-cmislib-net-module" title="Permalink to this headline">¶</a></h2> |
| <p>The <a class="reference internal" href="#module-cmislib.net" title="cmislib.net"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.net</span></code></a> Module contains the classes used by <a class="reference internal" href="#cmislib.model.CmisClient" title="cmislib.model.CmisClient"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.model.CmisClient</span></code></a> to communicate with the CMIS repository. The most important of which is <a class="reference internal" href="#cmislib.net.RESTService" title="cmislib.net.RESTService"><code class="xref py py-class docutils literal"><span class="pre">cmislib.net.RESTService</span></code></a>.</p> |
| <span class="target" id="module-cmislib.net"></span><p>Module that takes care of network communications for cmislib. It does |
| not know anything about CMIS or do anything special with regard to the |
| response it receives.</p> |
| <dl class="class"> |
| <dt id="cmislib.net.RESTService"> |
| <em class="property">class </em><code class="descclassname">cmislib.net.</code><code class="descname">RESTService</code><a class="headerlink" href="#cmislib.net.RESTService" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Generic service for interacting with an HTTP end point. Sets headers |
| such as the USER_AGENT and builds the basic auth handler.</p> |
| <dl class="method"> |
| <dt id="cmislib.net.RESTService.delete"> |
| <code class="descname">delete</code><span class="sig-paren">(</span><em>url</em>, <em>username=None</em>, <em>password=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.net.RESTService.delete" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Makes a delete request to the URL specified.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.net.RESTService.get"> |
| <code class="descname">get</code><span class="sig-paren">(</span><em>url</em>, <em>username=None</em>, <em>password=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.net.RESTService.get" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Makes a get request to the URL specified.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.net.RESTService.post"> |
| <code class="descname">post</code><span class="sig-paren">(</span><em>url</em>, <em>payload</em>, <em>contentType</em>, <em>username=None</em>, <em>password=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.net.RESTService.post" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Makes a POST request to the URL specified and posts the payload |
| that gets passed in. The content type header gets set to the |
| specified content type.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="cmislib.net.RESTService.put"> |
| <code class="descname">put</code><span class="sig-paren">(</span><em>url</em>, <em>payload</em>, <em>contentType</em>, <em>username=None</em>, <em>password=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#cmislib.net.RESTService.put" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Makes a PUT request to the URL specified and includes the payload |
| that gets passed in. The content type header gets set to the |
| specified content type.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="the-tests-module"> |
| <h2>The <a class="reference internal" href="#module-tests" title="tests"><code class="xref py py-mod docutils literal"><span class="pre">tests</span></code></a> Module<a class="headerlink" href="#the-tests-module" title="Permalink to this headline">¶</a></h2> |
| <p>The <a class="reference internal" href="#module-tests" title="tests"><code class="xref py py-mod docutils literal"><span class="pre">tests</span></code></a> Module contains unit tests for all classes and methods in <a class="reference internal" href="#module-cmislib.model" title="cmislib.model"><code class="xref py py-mod docutils literal"><span class="pre">cmislib.model</span></code></a>. See <a class="reference internal" href="tests.html#tests"><span class="std std-ref">Tests</span></a> for more information on running tests.</p> |
| <span class="target" id="module-tests"></span></div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h3><a href="index.html">Table Of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">Code</a><ul> |
| <li><a class="reference internal" href="#the-cmislib-model-module">The <code class="docutils literal"><span class="pre">cmislib.model</span></code> Module</a></li> |
| <li><a class="reference internal" href="#the-cmislib-domain-module">The <code class="docutils literal"><span class="pre">cmislib.domain</span></code> Module</a></li> |
| <li><a class="reference internal" href="#the-cmislib-net-module">The <code class="docutils literal"><span class="pre">cmislib.net</span></code> Module</a></li> |
| <li><a class="reference internal" href="#the-tests-module">The <code class="docutils literal"><span class="pre">tests</span></code> Module</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="bindings.html" |
| title="previous chapter">Bindings</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="codemisc.html" |
| title="next chapter">Miscellaneous Code</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="_sources/code.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3>Quick search</h3> |
| <form class="search" action="search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <script type="text/javascript">$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| >index</a></li> |
| <li class="right" > |
| <a href="py-modindex.html" title="Python Module Index" |
| >modules</a> |</li> |
| <li class="right" > |
| <a href="codemisc.html" title="Miscellaneous Code" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="bindings.html" title="Bindings" |
| >previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> »</li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2017, Apache Software Foundation. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1. |
| </div> |
| </body> |
| </html> |
