--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_workflow.html Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,653 @@
+
+<!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>pyams_workflow package — PyAMS User Guide 0.1.0 documentation</title>
+ <link rel="stylesheet" href="_static/pyramid.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.1.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="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+ </head>
+ <body>
+
+ <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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="pyams-workflow-package">
+<h1>pyams_workflow package<a class="headerlink" href="#pyams-workflow-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_workflow.interfaces.html">pyams_workflow.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.interfaces.html#module-pyams_workflow.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_workflow.tests.html">pyams_workflow.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#module-pyams_workflow.tests.test_utilsdocs">pyams_workflow.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#module-pyams_workflow.tests.test_utilsdocstrings">pyams_workflow.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#module-pyams_workflow.tests">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_workflow.zmi.html">pyams_workflow.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html">pyams_workflow.zmi.viewlet package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html#module-pyams_workflow.zmi.viewlet.versions">pyams_workflow.zmi.viewlet.versions module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html#module-pyams_workflow.zmi.viewlet">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi.interfaces">pyams_workflow.zmi.interfaces module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi.transition">pyams_workflow.zmi.transition module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi.versions">pyams_workflow.zmi.versions module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi.workflow">pyams_workflow.zmi.workflow module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_workflow.content">
+<span id="pyams-workflow-content-module"></span><h2>pyams_workflow.content module<a class="headerlink" href="#module-pyams_workflow.content" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_workflow.content.WorkflowContentDisplayedDateVocabulary">
+<em class="property">class </em><code class="descclassname">pyams_workflow.content.</code><code class="descname">WorkflowContentDisplayedDateVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.WorkflowContentDisplayedDateVocabulary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
+<p>Workflow content displayed date vocabulary</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo">
+<em class="property">class </em><code class="descclassname">pyams_workflow.content.</code><code class="descname">WorkflowContentPublicationInfo</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
+<p>Workflow content info</p>
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.displayed_publication_date">
+<code class="descname">displayed_publication_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.displayed_publication_date" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.first_publication_date">
+<code class="descname">first_publication_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.first_publication_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.is_published">
+<code class="descname">is_published</code><span class="sig-paren">(</span><em>check_parent=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.is_published" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.is_visible">
+<code class="descname">is_visible</code><span class="sig-paren">(</span><em>request=None</em>, <em>check_parent=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.is_visible" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication">
+<code class="descname">publication</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_date">
+<code class="descname">publication_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_effective_date">
+<code class="descname">publication_effective_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication_effective_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_expiration_date">
+<code class="descname">publication_expiration_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication_expiration_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publisher">
+<code class="descname">publisher</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publisher" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date">
+<code class="descname">push_end_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date_index">
+<code class="descname">push_end_date_index</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date_index" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfo.reset">
+<code class="descname">reset</code><span class="sig-paren">(</span><em>complete=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.reset" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.content.WorkflowContentPublicationInfoFactory">
+<code class="descclassname">pyams_workflow.content.</code><code class="descname">WorkflowContentPublicationInfoFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfoFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Workflow content info factory</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.content.handle_cloned_object">
+<code class="descclassname">pyams_workflow.content.</code><code class="descname">handle_cloned_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.handle_cloned_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add comment when an object is cloned</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.content.handle_cloned_publication_support">
+<code class="descclassname">pyams_workflow.content.</code><code class="descname">handle_cloned_publication_support</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.content.handle_cloned_publication_support" title="Permalink to this definition">¶</a></dt>
+<dd><p>Reset publication info when an object is cloned</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_workflow.include">
+<span id="pyams-workflow-include-module"></span><h2>pyams_workflow.include module<a class="headerlink" href="#module-pyams_workflow.include" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_workflow.include.include_package">
+<code class="descclassname">pyams_workflow.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.include.include_package" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_workflow.versions">
+<span id="pyams-workflow-versions-module"></span><h2>pyams_workflow.versions module<a class="headerlink" href="#module-pyams_workflow.versions" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_workflow.versions.WorkflowContentVersionsFactory">
+<code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowContentVersionsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowContentVersionsFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Workflow versions factory</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem">
+<em class="property">class </em><code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowHistoryItem</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
+<p>Workflow history item</p>
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.comment">
+<code class="descname">comment</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.comment" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.date">
+<code class="descname">date</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.date" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.principal">
+<code class="descname">principal</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.principal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.source_state">
+<code class="descname">source_state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.source_state" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.source_version">
+<code class="descname">source_version</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.source_version" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.target_state">
+<code class="descname">target_state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.target_state" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.transition">
+<code class="descname">transition</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.transition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowHistoryItem.transition_id">
+<code class="descname">transition_id</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.transition_id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.versions.WorkflowVersionState">
+<em class="property">class </em><code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersionState</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
+<p>Workflow managed content version object</p>
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersionState.get_first_state_date">
+<code class="descname">get_first_state_date</code><span class="sig-paren">(</span><em>states</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.get_first_state_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowVersionState.state">
+<code class="descname">state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowVersionState.state_date">
+<code class="descname">state_date</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_date" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowVersionState.state_principal">
+<code class="descname">state_principal</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_principal" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowVersionState.state_urgency">
+<code class="descname">state_urgency</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_urgency" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.versions.WorkflowVersionState.version_id">
+<code class="descname">version_id</code><em class="property"> = None</em><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.version_id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.versions.WorkflowVersionStateFactory">
+<code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersionStateFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionStateFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Workflow content version state factory</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.versions.WorkflowVersionVersionsFactory">
+<code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersionVersionsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionVersionsFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Workflow versions factory for version</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.versions.WorkflowVersions">
+<em class="property">class </em><code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersions</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
+<p>Workflow versions adapter</p>
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.add_version">
+<code class="descname">add_version</code><span class="sig-paren">(</span><em>content</em>, <em>state</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.add_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.get_last_versions">
+<code class="descname">get_last_versions</code><span class="sig-paren">(</span><em>count=1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.get_last_versions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.get_version">
+<code class="descname">get_version</code><span class="sig-paren">(</span><em>version_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.get_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.get_versions">
+<code class="descname">get_versions</code><span class="sig-paren">(</span><em>states=None</em>, <em>sort=False</em>, <em>reverse=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.get_versions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.has_version">
+<code class="descname">has_version</code><span class="sig-paren">(</span><em>states</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.has_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.remove_version">
+<code class="descname">remove_version</code><span class="sig-paren">(</span><em>version_id</em>, <em>state='deleted'</em>, <em>comment=None</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.remove_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersions.set_state">
+<code class="descname">set_state</code><span class="sig-paren">(</span><em>version_id</em>, <em>state</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersions.set_state" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.versions.WorkflowVersionsSublocations">
+<em class="property">class </em><code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersionsSublocations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionsSublocations" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
+<p>Workflow versions sub-locations</p>
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersionsSublocations.sublocations">
+<code class="descname">sublocations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionsSublocations.sublocations" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.versions.WorkflowVersionsTraverser">
+<em class="property">class </em><code class="descclassname">pyams_workflow.versions.</code><code class="descname">WorkflowVersionsTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionsTraverser" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
+<p>++versions++ namespace traverser</p>
+<dl class="method">
+<dt id="pyams_workflow.versions.WorkflowVersionsTraverser.traverse">
+<code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionsTraverser.traverse" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.versions.handle_workflow_transition">
+<code class="descclassname">pyams_workflow.versions.</code><code class="descname">handle_workflow_transition</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.handle_workflow_transition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle workflow transition</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.versions.handle_workflow_version_transition">
+<code class="descclassname">pyams_workflow.versions.</code><code class="descname">handle_workflow_version_transition</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.versions.handle_workflow_version_transition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle workflow version transition</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_workflow.workflow">
+<span id="pyams-workflow-workflow-module"></span><h2>pyams_workflow.workflow module<a class="headerlink" href="#module-pyams_workflow.workflow" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_workflow.workflow.NullAction">
+<code class="descclassname">pyams_workflow.workflow.</code><code class="descname">NullAction</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.NullAction" title="Permalink to this definition">¶</a></dt>
+<dd><p>Null action</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.workflow.NullCondition">
+<code class="descclassname">pyams_workflow.workflow.</code><code class="descname">NullCondition</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.NullCondition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Null condition</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.workflow.Transition">
+<em class="property">class </em><code class="descclassname">pyams_workflow.workflow.</code><code class="descname">Transition</code><span class="sig-paren">(</span><em>transition_id</em>, <em>title</em>, <em>source</em>, <em>destination</em>, <em>condition=<function NullCondition></em>, <em>action=<function NullAction></em>, <em>trigger=0</em>, <em>permission=None</em>, <em>order=0</em>, <em>**user_data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Transition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Transition object</p>
+<p>A transition doesn’t make anything by itself.
+Everything is handled by the workflow utility</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.workflow.Workflow">
+<em class="property">class </em><code class="descclassname">pyams_workflow.workflow.</code><code class="descname">Workflow</code><span class="sig-paren">(</span><em>transitions</em>, <em>states</em>, <em>initial_state=None</em>, <em>update_states=None</em>, <em>readonly_states=None</em>, <em>protected_states=None</em>, <em>manager_states=None</em>, <em>published_states=None</em>, <em>waiting_states=None</em>, <em>retired_states=None</em>, <em>archived_states=None</em>, <em>auto_retired_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Workflow utility</p>
+<dl class="method">
+<dt id="pyams_workflow.workflow.Workflow.get_state_label">
+<code class="descname">get_state_label</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow.get_state_label" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.Workflow.get_transition">
+<code class="descname">get_transition</code><span class="sig-paren">(</span><em>source</em>, <em>transition_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow.get_transition" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.Workflow.get_transition_by_id">
+<code class="descname">get_transition_by_id</code><span class="sig-paren">(</span><em>transition_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow.get_transition_by_id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.Workflow.get_transitions">
+<code class="descname">get_transitions</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow.get_transitions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.Workflow.refresh">
+<code class="descname">refresh</code><span class="sig-paren">(</span><em>transitions</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.Workflow.refresh" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.workflow.WorkflowInfo">
+<em class="property">class </em><code class="descclassname">pyams_workflow.workflow.</code><code class="descname">WorkflowInfo</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Workflow info adapter</p>
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.fire_automatic">
+<code class="descname">fire_automatic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.fire_automatic" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition">
+<code class="descname">fire_transition</code><span class="sig-paren">(</span><em>transition_id</em>, <em>comment=None</em>, <em>side_effect=None</em>, <em>check_security=True</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.fire_transition" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition_for_versions">
+<code class="descname">fire_transition_for_versions</code><span class="sig-paren">(</span><em>state</em>, <em>transition_id</em>, <em>comment=None</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.fire_transition_for_versions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition_toward">
+<code class="descname">fire_transition_toward</code><span class="sig-paren">(</span><em>state</em>, <em>comment=None</em>, <em>side_effect=None</em>, <em>check_security=True</em>, <em>principal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.fire_transition_toward" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.get_automatic_transition_ids">
+<code class="descname">get_automatic_transition_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.get_automatic_transition_ids" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids">
+<code class="descname">get_fireable_transition_ids</code><span class="sig-paren">(</span><em>check_security=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids_toward">
+<code class="descname">get_fireable_transition_ids_toward</code><span class="sig-paren">(</span><em>state</em>, <em>check_security=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids_toward" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.get_manual_transition_ids">
+<code class="descname">get_manual_transition_ids</code><span class="sig-paren">(</span><em>check_security=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.get_manual_transition_ids" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.get_system_transition_ids">
+<code class="descname">get_system_transition_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.get_system_transition_ids" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.has_automatic_transitions">
+<code class="descname">has_automatic_transitions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.has_automatic_transitions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_workflow.workflow.WorkflowInfo.has_version">
+<code class="descname">has_version</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.has_version" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.workflow.WorkflowInfo.name">
+<code class="descname">name</code><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.name" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.workflow.WorkflowInfo.parent">
+<code class="descname">parent</code><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.parent" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_workflow.workflow.WorkflowsVocabulary">
+<em class="property">class </em><code class="descclassname">pyams_workflow.workflow.</code><code class="descname">WorkflowsVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.WorkflowsVocabulary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p>
+<p>Workflows vocabulary</p>
+<dl class="attribute">
+<dt id="pyams_workflow.workflow.WorkflowsVocabulary.interface">
+<code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_workflow.interfaces.IWorkflow></em><a class="headerlink" href="#pyams_workflow.workflow.WorkflowsVocabulary.interface" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_workflow.workflow.WorkflowsVocabulary.nameOnly">
+<code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_workflow.workflow.WorkflowsVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_workflow.workflow.granted_permission">
+<code class="descclassname">pyams_workflow.workflow.</code><code class="descname">granted_permission</code><span class="sig-paren">(</span><em>permission</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.workflow.granted_permission" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-pyams_workflow">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_workflow" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_workflow.includeme">
+<code class="descclassname">pyams_workflow.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</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="#">pyams_workflow package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_workflow.content">pyams_workflow.content module</a></li>
+<li><a class="reference internal" href="#module-pyams_workflow.include">pyams_workflow.include module</a></li>
+<li><a class="reference internal" href="#module-pyams_workflow.versions">pyams_workflow.versions module</a></li>
+<li><a class="reference internal" href="#module-pyams_workflow.workflow">pyams_workflow.workflow module</a></li>
+<li><a class="reference internal" href="#module-pyams_workflow">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+<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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2017, Thierry Florac.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+ </div>
+ </body>
+</html>
\ No newline at end of file