Modified: chemistry/site/trunk/content/python/docs/code.html URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/python/docs/code.html?rev=1806797&r1=1806796&r2=1806797&view=diff ============================================================================== --- chemistry/site/trunk/content/python/docs/code.html (original) +++ chemistry/site/trunk/content/python/docs/code.html Thu Aug 31 14:19:04 2017 @@ -1,5 +1,3 @@ - - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> @@ -8,30 +6,32 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Code — Apache Chemistry cmislib 0.5.1 documentation</title> + <title>Code — Apache Chemistry cmislib 0.6.0 documentation</title> - <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <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.5.1', + URL_ROOT: './', + VERSION: '0.6.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + 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="top" title="Apache Chemistry cmislib 0.5.1 documentation" href="index.html" /> - <link rel="next" title="Developer Guide" href="devguide.html" /> - <link rel="prev" title="Examples" href="examples.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> - <div class="related"> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> @@ -41,94 +41,173 @@ <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > - <a href="devguide.html" title="Developer Guide" + <a href="codemisc.html" title="Miscellaneous Code" accesskey="N">next</a> |</li> <li class="right" > - <a href="examples.html" title="Examples" + <a href="bindings.html" title="Bindings" accesskey="P">previous</a> |</li> - <li><a href="index.html">Apache Chemistry cmislib 0.5.1 documentation</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"> + <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"><tt class="xref py py-mod docutils literal"><span class="pre">cmislib.model</span></tt></a> Module<a class="headerlink" href="#the-cmislib-model-module" title="Permalink to this headline">¶</a></h2> -<p>The <a class="reference internal" href="#module-cmislib.model" title="cmislib.model"><tt class="xref py py-mod docutils literal"><span class="pre">cmislib.model</span></tt></a> Module contains all the CMIS domain objects. The ones you will work with are listed as top level package elements. When working with the repository, the first thing you need to do is grab an instance of <tt class="xref py py-class docutils literal"><span class="pre">cmislib.CmisClient</span></tt>, passing it the repository endpoint URL, username, and password.</p> -<p>For example, in Alfresco 4 and higher, the repository endpoint is -‘<a class="reference external" href="http://localhost:8080/alfresco/cmisatom";>http://localhost:8080/alfresco/cmisatom</a>‘. In earlier versions of -Alfresco, the endpoint is -‘<a class="reference external" href="http://localhost:8080/alfresco/s/api/cmis";>http://localhost:8080/alfresco/s/api/cmis</a>‘. In both cases, the -default username and password are ‘admin’ and ‘admin’.</p> -<div class="highlight-python"><div class="highlight"><pre><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="s">'http://localhost:8080/alfresco/s/cmis'</span><span class="p">,</span> <span class="s">'admin'</span><span class="p">,</span> <span class="s">'admin'</span><span class="p">)</span> +<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-python"><div class="highlight"><pre><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> +<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>or a specific repository if you know the repository ID.</p> -<div class="highlight-python"><div class="highlight"><pre><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="s">'83beb297-a6fa-4ac5-844b-98c871c0eea9'</span><span class="p">)</span> +<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 <tt class="xref py py-class docutils literal"><span class="pre">cmislib.Repository</span></tt> class to create new <tt class="xref py py-class docutils literal"><span class="pre">cmislib.Folder</span></tt> and <tt class="xref py py-class docutils literal"><span class="pre">cmislib.Document</span></tt> objects, perform searches, etc.</p> -<span class="target" id="module-cmislib.model"></span><p>Module containing the domain objects used to work with a CMIS provider.</p> +<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.ACE"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">ACE</tt><big>(</big><em>principalId=None</em>, <em>permissions=None</em>, <em>direct=None</em><big>)</big><a class="headerlink" href="#cmislib.model.ACE" title="Permalink to this definition">¶</a></dt> +<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.model.ACE.direct"> -<tt class="descname">direct</tt><a class="headerlink" href="#cmislib.model.ACE.direct" title="Permalink to this definition">¶</a></dt> +<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.model.ACE.permissions"> -<tt class="descname">permissions</tt><a class="headerlink" href="#cmislib.model.ACE.permissions" title="Permalink to this definition">¶</a></dt> +<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.model.ACE.principalId"> -<tt class="descname">principalId</tt><a class="headerlink" href="#cmislib.model.ACE.principalId" title="Permalink to this definition">¶</a></dt> +<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.model.ACL"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">ACL</tt><big>(</big><em>aceList=None</em>, <em>xmlDoc=None</em><big>)</big><a class="headerlink" href="#cmislib.model.ACL" title="Permalink to this definition">¶</a></dt> +<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.model.ACL.addEntry"> -<tt class="descname">addEntry</tt><big>(</big><em>ace</em><big>)</big><a class="headerlink" href="#cmislib.model.ACL.addEntry" title="Permalink to this definition">¶</a></dt> -<dd><p>Adds an <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> entry to the ACL.</p> -<div class="highlight-python"><div class="highlight"><pre><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="s">'jpotts'</span><span class="p">,</span> <span class="s">'cmis:read'</span><span class="p">,</span> <span class="s">'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="s">'jsmith'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">))</span> +<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.model.ACE object at 0x100731410>, u'jdoe': <cmislib.model.ACE object at 0x100731150>, 'jpotts': <cmislib.model.ACE object at 0x1005a22d0>, 'jsmith': <cmislib.model.ACE object at 0x1005a2210>}</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.model.ACL.clearEntries"> -<tt class="descname">clearEntries</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ACL.clearEntries" title="Permalink to this definition">¶</a></dt> -<dd><p>Clears all <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> entries from the ACL and removes the internal +<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-python"><div class="highlight"><pre><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="s">'jsmith'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'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="s">'jpotts'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">))</span> +<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.model.ACE object at 0x1012c7310>, 'jsmith': <cmislib.model.ACE object at 0x100528490>}</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> @@ -139,17 +218,17 @@ XML representation of the ACL.</p> </dd></dl> <dl class="attribute"> -<dt id="cmislib.model.ACL.entries"> -<tt class="descname">entries</tt><a class="headerlink" href="#cmislib.model.ACL.entries" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dictionary of <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> objects for each Access Control +<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-python"><div class="highlight"><pre><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="s">'jsmith'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'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="s">'jpotts'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">))</span> +<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="k">print</span> <span class="s">'principal:</span><span class="si">%s</span><span class="s"> 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="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="k">print</span> <span class="n">perm</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> @@ -160,17 +239,17 @@ Entry in the ACL. The key value is the A </dd></dl> <dl class="method"> -<dt id="cmislib.model.ACL.getEntries"> -<tt class="descname">getEntries</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ACL.getEntries" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dictionary of <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> objects for each Access Control +<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-python"><div class="highlight"><pre><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="s">'jsmith'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'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="s">'jpotts'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">))</span> +<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="k">print</span> <span class="s">'principal:</span><span class="si">%s</span><span class="s"> 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="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="k">print</span> <span class="n">perm</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> @@ -181,22 +260,14 @@ Entry in the ACL. The key value is the A </dd></dl> <dl class="method"> -<dt id="cmislib.model.ACL.getXmlDoc"> -<tt class="descname">getXmlDoc</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ACL.getXmlDoc" title="Permalink to this definition">¶</a></dt> -<dd><p>This method rebuilds the local XML representation of the ACL based on -the <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> objects in the entries list and returns the resulting -XML Document.</p> -</dd></dl> - -<dl class="method"> -<dt id="cmislib.model.ACL.removeEntry"> -<tt class="descname">removeEntry</tt><big>(</big><em>principalId</em><big>)</big><a class="headerlink" href="#cmislib.model.ACL.removeEntry" title="Permalink to this definition">¶</a></dt> -<dd><p>Removes the <a class="reference internal" href="#cmislib.model.ACE" title="cmislib.model.ACE"><tt class="xref py py-class docutils literal"><span class="pre">ACE</span></tt></a> entry given a specific principalId.</p> -<div class="highlight-python"><div class="highlight"><pre><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.model.ACE object at 0x100731410>, u'jdoe': <cmislib.model.ACE object at 0x100731150>, 'jpotts': <cmislib.model.ACE object at 0x1005a22d0>, 'jsmith': <cmislib.model.ACE 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="s">'jsmith'</span><span class="p">)</span> +<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.model.ACE object at 0x100731410>, u'jdoe': <cmislib.model.ACE object at 0x100731150>, 'jpotts': <cmislib.model.ACE object at 0x1005a22d0>}</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> @@ -204,11 +275,11 @@ XML Document.</p> </dd></dl> <dl class="class"> -<dt id="cmislib.model.ChangeEntry"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">ChangeEntry</tt><big>(</big><em>cmisClient</em>, <em>repository</em>, <em>xmlDoc</em><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry" title="Permalink to this definition">¶</a></dt> +<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.model.Repository.getContentChanges" title="cmislib.model.Repository.getContentChanges"><tt class="xref py py-meth docutils literal"><span class="pre">Repository.getContentChanges()</span></tt></a>.</p> -<div class="highlight-python"><div class="highlight"><pre><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> +<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> @@ -228,14 +299,14 @@ XML Document.</p> </pre></div> </div> <dl class="attribute"> -<dt id="cmislib.model.ChangeEntry.changeTime"> -<tt class="descname">changeTime</tt><a class="headerlink" href="#cmislib.model.ChangeEntry.changeTime" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.changeType"> -<tt class="descname">changeType</tt><a class="headerlink" href="#cmislib.model.ChangeEntry.changeType" title="Permalink to this definition">¶</a></dt> +<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> @@ -249,20 +320,20 @@ one of:</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.ChangeEntry.getACL"> -<tt class="descname">getACL</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getACL" title="Permalink to this definition">¶</a></dt> -<dd><p>Gets the <a class="reference internal" href="#cmislib.model.ACL" title="cmislib.model.ACL"><tt class="xref py py-class docutils literal"><span class="pre">ACL</span></tt></a> object that is included with this Change Entry.</p> +<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.model.ChangeEntry.getChangeTime"> -<tt class="descname">getChangeTime</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getChangeTime" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.getChangeType"> -<tt class="descname">getChangeType</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getChangeType" title="Permalink to this definition">¶</a></dt> +<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> @@ -276,40 +347,40 @@ one of:</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.ChangeEntry.getId"> -<tt class="descname">getId</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getId" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.getObjectId"> -<tt class="descname">getObjectId</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getObjectId" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.getProperties"> -<tt class="descname">getProperties</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntry.getProperties" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.id"> -<tt class="descname">id</tt><a class="headerlink" href="#cmislib.model.ChangeEntry.id" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.objectId"> -<tt class="descname">objectId</tt><a class="headerlink" href="#cmislib.model.ChangeEntry.objectId" title="Permalink to this definition">¶</a></dt> +<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.model.ChangeEntry.properties"> -<tt class="descname">properties</tt><a class="headerlink" href="#cmislib.model.ChangeEntry.properties" title="Permalink to this definition">¶</a></dt> +<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> @@ -318,132 +389,22 @@ include the actual property values that </dd></dl> <dl class="class"> -<dt id="cmislib.model.ChangeEntryResultSet"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">ChangeEntryResultSet</tt><big>(</big><em>cmisClient</em>, <em>repository</em>, <em>xmlDoc</em><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntryResultSet" title="Permalink to this definition">¶</a></dt> -<dd><p>A specialized type of <a class="reference internal" href="#cmislib.model.ResultSet" title="cmislib.model.ResultSet"><tt class="xref py py-class docutils literal"><span class="pre">ResultSet</span></tt></a> that knows how to instantiate -<a class="reference internal" href="#cmislib.model.ChangeEntry" title="cmislib.model.ChangeEntry"><tt class="xref py py-class docutils literal"><span class="pre">ChangeEntry</span></tt></a> objects. The parent class assumes children of -<a class="reference internal" href="#cmislib.model.CmisObject" title="cmislib.model.CmisObject"><tt class="xref py py-class docutils literal"><span class="pre">CmisObject</span></tt></a> which doesn’t work for ChangeEntries.</p> +<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.model.ChangeEntryResultSet.getResults"> -<tt class="descname">getResults</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.ChangeEntryResultSet.getResults" title="Permalink to this definition">¶</a></dt> +<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.model.CmisClient"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">CmisClient</tt><big>(</big><em>repositoryUrl</em>, <em>username</em>, <em>password</em>, <em>**kwargs</em><big>)</big><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"> -<tt class="descname">defaultRepository</tt><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-python"><div class="highlight"><pre><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.delete"> -<tt class="descname">delete</tt><big>(</big><em>url</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisClient.delete" title="Permalink to this definition">¶</a></dt> -<dd><p>Does a delete against the CMIS service. More than likely, you will not -need to call this method. Instead, let the other objects do it for you.</p> -<p>For example, to delete a folder you’d call <tt class="xref py py-class docutils literal"><span class="pre">Folder.delete</span></tt> and -to delete a document you’d call <tt class="xref py py-class docutils literal"><span class="pre">Document.delete</span></tt>.</p> -</dd></dl> - -<dl class="method"> -<dt id="cmislib.model.CmisClient.get"> -<tt class="descname">get</tt><big>(</big><em>url</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisClient.get" title="Permalink to this definition">¶</a></dt> -<dd><p>Does a get against the CMIS service. More than likely, you will not -need to call this method. Instead, let the other objects do it for you.</p> -<p>For example, if you need to get a specific object by object id, try -<a class="reference internal" href="#cmislib.model.Repository.getObject" title="cmislib.model.Repository.getObject"><tt class="xref py py-class docutils literal"><span class="pre">Repository.getObject</span></tt></a>. If you have a path instead of an object -id, use <a class="reference internal" href="#cmislib.model.Repository.getObjectByPath" title="cmislib.model.Repository.getObjectByPath"><tt class="xref py py-class docutils literal"><span class="pre">Repository.getObjectByPath</span></tt></a>. Or, you could start with -the root folder (<a class="reference internal" href="#cmislib.model.Repository.getRootFolder" title="cmislib.model.Repository.getRootFolder"><tt class="xref py py-class docutils literal"><span class="pre">Repository.getRootFolder</span></tt></a>) and drill down from -there.</p> -</dd></dl> - -<dl class="method"> -<dt id="cmislib.model.CmisClient.getDefaultRepository"> -<tt class="descname">getDefaultRepository</tt><big>(</big><big>)</big><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-python"><div class="highlight"><pre><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"> -<tt class="descname">getRepositories</tt><big>(</big><big>)</big><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> -<p>See CMIS specification document 2.2.2.1 getRepositories</p> -<div class="highlight-python"><div class="highlight"><pre><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"> -<tt class="descname">getRepository</tt><big>(</big><em>repositoryId</em><big>)</big><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-python"><div class="highlight"><pre><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="s">'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="method"> -<dt id="cmislib.model.CmisClient.post"> -<tt class="descname">post</tt><big>(</big><em>url</em>, <em>payload</em>, <em>contentType</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisClient.post" title="Permalink to this definition">¶</a></dt> -<dd><p>Does a post against the CMIS service. More than likely, you will not -need to call this method. Instead, let the other objects do it for you.</p> -<p>For example, to update the properties on an object, you’d call -<a class="reference internal" href="#cmislib.model.CmisObject.updateProperties" title="cmislib.model.CmisObject.updateProperties"><tt class="xref py py-class docutils literal"><span class="pre">CmisObject.updateProperties</span></tt></a>. Or, to check in a document that’s -been checked out, you’d call <a class="reference internal" href="#cmislib.model.Document.checkin" title="cmislib.model.Document.checkin"><tt class="xref py py-class docutils literal"><span class="pre">Document.checkin</span></tt></a> on the PWC.</p> -</dd></dl> - -<dl class="method"> -<dt id="cmislib.model.CmisClient.put"> -<tt class="descname">put</tt><big>(</big><em>url</em>, <em>payload</em>, <em>contentType</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisClient.put" title="Permalink to this definition">¶</a></dt> -<dd><p>Does a put against the CMIS service. More than likely, you will not -need to call this method. Instead, let the other objects do it for you.</p> -<p>For example, to update the properties on an object, you’d call -<a class="reference internal" href="#cmislib.model.CmisObject.updateProperties" title="cmislib.model.CmisObject.updateProperties"><tt class="xref py py-class docutils literal"><span class="pre">CmisObject.updateProperties</span></tt></a>. Or, to check in a document that’s -been checked out, you’d call <a class="reference internal" href="#cmislib.model.Document.checkin" title="cmislib.model.Document.checkin"><tt class="xref py py-class docutils literal"><span class="pre">Document.checkin</span></tt></a> on the PWC.</p> -</dd></dl> - -<dl class="attribute"> -<dt id="cmislib.model.CmisClient.repositories"> -<tt class="descname">repositories</tt><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> -<p>See CMIS specification document 2.2.2.1 getRepositories</p> -<div class="highlight-python"><div class="highlight"><pre><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> - -<dl class="class"> -<dt id="cmislib.model.CmisId"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">CmisId</tt><a class="headerlink" href="#cmislib.model.CmisId" title="Permalink to this definition">¶</a></dt> +<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 @@ -451,30 +412,29 @@ cmis:propertyString.</p> </dd></dl> <dl class="class"> -<dt id="cmislib.model.CmisObject"> -<em class="property">class </em><tt class="descclassname">cmislib.model.</tt><tt class="descname">CmisObject</tt><big>(</big><em>cmisClient</em>, <em>repository</em>, <em>objectId=None</em>, <em>xmlDoc=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject" title="Permalink to this definition">¶</a></dt> +<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.model.Document" title="cmislib.model.Document"><tt class="xref py py-class docutils literal"><span class="pre">Document</span></tt></a> and <a class="reference internal" href="#cmislib.model.Folder" title="cmislib.model.Folder"><tt class="xref py py-class docutils literal"><span class="pre">Folder</span></tt></a>.</p> +<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.model.CmisObject.ACL"> -<tt class="descname">ACL</tt><a class="headerlink" href="#cmislib.model.CmisObject.ACL" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><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> +<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.model.ACE object at 0x10071a8d0>, 'jdoe': <cmislib.model.ACE object at 0x10071a590>}</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>See CMIS specification document 2.2.10.1 getACL</p> <p>The optional onlyBasicPermissions argument is currently not supported.</p> </dd></dl> <dl class="attribute"> -<dt id="cmislib.model.CmisObject.allowableActions"> -<tt class="descname">allowableActions</tt><a class="headerlink" href="#cmislib.model.CmisObject.allowableActions" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><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> +<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="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</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="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> @@ -487,38 +447,35 @@ cmis:propertyString.</p> <span class="go">canGetProperties:True</span> </pre></div> </div> -<p>See CMIS specification document 2.2.4.6 getAllowableActions</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.applyACL"> -<tt class="descname">applyACL</tt><big>(</big><em>acl</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.applyACL" title="Permalink to this definition">¶</a></dt> -<dd><p>Updates the object with the provided <a class="reference internal" href="#cmislib.model.ACL" title="cmislib.model.ACL"><tt class="xref py py-class docutils literal"><span class="pre">ACL</span></tt></a>. +<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-python"><div class="highlight"><pre><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="s">'jdoe'</span><span class="p">,</span> <span class="s">'cmis:write'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">))</span> +<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.model.ACE object at 0x10071a8d0>, 'jdoe': <cmislib.model.ACE object at 0x10071a590>}</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>See CMIS specification document 2.2.10.2 applyACL</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.applyPolicy"> -<tt class="descname">applyPolicy</tt><big>(</big><em>policyId</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.applyPolicy" title="Permalink to this definition">¶</a></dt> +<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> -<p>See CMIS specification document 2.2.9.1 applyPolicy</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.createRelationship"> -<tt class="descname">createRelationship</tt><big>(</big><em>targetObj</em>, <em>relTypeId</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.createRelationship" title="Permalink to this definition">¶</a></dt> +<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.model.Relationship" title="cmislib.model.Relationship"><tt class="xref py py-class docutils literal"><span class="pre">Relationship</span></tt></a> object.</p> -<div class="highlight-python"><div class="highlight"><pre><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="s">'R:cmiscustom:assoc'</span><span class="p">)</span> +<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> @@ -526,40 +483,38 @@ object using the relationship type speci </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.delete"> -<tt class="descname">delete</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.delete" title="Permalink to this definition">¶</a></dt> -<dd><p>Deletes this <a class="reference internal" href="#cmislib.model.CmisObject" title="cmislib.model.CmisObject"><tt class="xref py py-class docutils literal"><span class="pre">CmisObject</span></tt></a> from the repository. Note that in the -case of a <a class="reference internal" href="#cmislib.model.Folder" title="cmislib.model.Folder"><tt class="xref py py-class docutils literal"><span class="pre">Folder</span></tt></a> object, some repositories will refuse to +<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.model.Folder.deleteTree" title="cmislib.model.Folder.deleteTree"><tt class="xref py py-meth docutils literal"><span class="pre">deleteTree()</span></tt></a> instead.</p> -<p>See CMIS specification document 2.2.4.14 delete</p> -<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">folder</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> +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.model.CmisObject.getACL"> -<tt class="descname">getACL</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getACL" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><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> +<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.model.ACE object at 0x10071a8d0>, 'jdoe': <cmislib.model.ACE object at 0x10071a590>}</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>See CMIS specification document 2.2.10.1 getACL</p> <p>The optional onlyBasicPermissions argument is currently not supported.</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getAllowableActions"> -<tt class="descname">getAllowableActions</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getAllowableActions" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><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> +<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="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">"</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="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> @@ -572,33 +527,31 @@ of its descendants, use <a class="refere <span class="go">canGetProperties:True</span> </pre></div> </div> -<p>See CMIS specification document 2.2.4.6 getAllowableActions</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getAppliedPolicies"> -<tt class="descname">getAppliedPolicies</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getAppliedPolicies" title="Permalink to this definition">¶</a></dt> +<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> -<p>See CMIS specification document 2.2.9.3 getAppliedPolicies</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getName"> -<tt class="descname">getName</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getName" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">doc</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span> +<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.model.CmisObject.getObjectId"> -<tt class="descname">getObjectId</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getObjectId" title="Permalink to this definition">¶</a></dt> +<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-python"><div class="highlight"><pre><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> +<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> @@ -606,9 +559,9 @@ is a pretty common one so it seems to ma </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getObjectParents"> -<tt class="descname">getObjectParents</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getObjectParents" title="Permalink to this definition">¶</a></dt> -<dd><p>See CMIS specification document 2.2.3.5 getObjectParents</p> +<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"> @@ -623,21 +576,20 @@ is a pretty common one so it seems to ma </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getPaths"> -<tt class="descname">getPaths</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getPaths" title="Permalink to this definition">¶</a></dt> +<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.model.CmisObject.getProperties"> -<tt class="descname">getProperties</tt><big>(</big><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getProperties" title="Permalink to this definition">¶</a></dt> +<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> -<p>See CMIS specification document 2.2.4.8 getProperties</p> -<div class="highlight-python"><div class="highlight"><pre><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> +<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="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</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="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> @@ -652,12 +604,11 @@ dict with a value of None.</p> </dd></dl> <dl class="method"> -<dt id="cmislib.model.CmisObject.getRelationships"> -<tt class="descname">getRelationships</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cmislib.model.CmisObject.getRelationships" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a <a class="reference internal" href="#cmislib.model.ResultSet" title="cmislib.model.ResultSet"><tt class="xref py py-class docutils literal"><span class="pre">ResultSet</span></tt></a> of <a class="reference internal" href="#cmislib.model.Relationship" title="cmislib.model.Relationship"><tt class="xref py py-class docutils literal"><span class="pre">Relationship</span></tt></a> objects for each +<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> -<p>See CMIS specification document 2.2.8.1 getObjectRelationships</p>
[... 2647 lines stripped ...]
