--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_content.workflow.html Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,298 @@
+
+<!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_content.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-content-workflow-package">
+<h1>pyams_content.workflow package<a class="headerlink" href="#pyams-content-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_content.workflow.zmi.html">pyams_content.workflow.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content.workflow.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content.workflow.zmi.html#module-pyams_content.workflow.zmi.task">pyams_content.workflow.zmi.task module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content.workflow.zmi.html#module-pyams_content.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_content.workflow.interfaces">
+<span id="pyams-content-workflow-interfaces-module"></span><h2>pyams_content.workflow.interfaces module<a class="headerlink" href="#module-pyams_content.workflow.interfaces" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_content.workflow.notify">
+<span id="pyams-content-workflow-notify-module"></span><h2>pyams_content.workflow.notify module<a class="headerlink" href="#module-pyams_content.workflow.notify" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content.workflow.notify.ContentWorkflowTransitionNotificationHandler">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.notify.</code><code class="descname">ContentWorkflowTransitionNotificationHandler</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.notify.ContentWorkflowTransitionNotificationHandler" 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>Content workflow transition notification handler</p>
+<dl class="method">
+<dt id="pyams_content.workflow.notify.ContentWorkflowTransitionNotificationHandler.get_target">
+<code class="descname">get_target</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.notify.ContentWorkflowTransitionNotificationHandler.get_target" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.notify.handle_workflow_event">
+<code class="descclassname">pyams_content.workflow.notify.</code><code class="descname">handle_workflow_event</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.notify.handle_workflow_event" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle workflow transition event</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content.workflow.task">
+<span id="pyams-content-workflow-task-module"></span><h2>pyams_content.workflow.task module<a class="headerlink" href="#module-pyams_content.workflow.task" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content.workflow.task.ContentArchiverTask">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.task.</code><code class="descname">ContentArchiverTask</code><a class="headerlink" href="#pyams_content.workflow.task.ContentArchiverTask" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_scheduler.html#pyams_scheduler.task.Task" title="pyams_scheduler.task.Task"><code class="xref py py-class docutils literal"><span class="pre">pyams_scheduler.task.Task</span></code></a></p>
+<p>“Content archiver task</p>
+<dl class="method">
+<dt id="pyams_content.workflow.task.ContentArchiverTask.run">
+<code class="descname">run</code><span class="sig-paren">(</span><em>report</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.task.ContentArchiverTask.run" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content.workflow.task.ContentArchiverTask.settings_view_name">
+<code class="descname">settings_view_name</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.workflow.task.ContentArchiverTask.settings_view_name" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content.workflow">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.workflow" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content.workflow.ContentWorkflow">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.</code><code class="descname">ContentWorkflow</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_content.workflow.ContentWorkflow" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_workflow.html#pyams_workflow.workflow.Workflow" title="pyams_workflow.workflow.Workflow"><code class="xref py py-class docutils literal"><span class="pre">pyams_workflow.workflow.Workflow</span></code></a></p>
+<p>PyAMS default content workflow</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.workflow.DraftWorkflowStateLabelAdapter">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.</code><code class="descname">DraftWorkflowStateLabelAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.DraftWorkflowStateLabelAdapter" 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>Draft state label adapter</p>
+<dl class="staticmethod">
+<dt id="pyams_content.workflow.DraftWorkflowStateLabelAdapter.get_label">
+<em class="property">static </em><code class="descname">get_label</code><span class="sig-paren">(</span><em>content</em>, <em>request=None</em>, <em>format=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.DraftWorkflowStateLabelAdapter.get_label" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_content.workflow.MANAGER_STATES">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">MANAGER_STATES</code><em class="property"> = ('proposed',)</em><a class="headerlink" href="#pyams_content.workflow.MANAGER_STATES" title="Permalink to this definition">¶</a></dt>
+<dd><p>Only managers can update proposed contents (if their restrictions apply)</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_content.workflow.PROTECTED_STATES">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">PROTECTED_STATES</code><em class="property"> = ('published', 'retiring')</em><a class="headerlink" href="#pyams_content.workflow.PROTECTED_STATES" title="Permalink to this definition">¶</a></dt>
+<dd><p>Protected states are available to webmasters in update mode</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_content.workflow.READONLY_STATES">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">READONLY_STATES</code><em class="property"> = ('retired', 'archiving', 'archived', 'deleted')</em><a class="headerlink" href="#pyams_content.workflow.READONLY_STATES" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retired and archived contents can’t be modified</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="pyams_content.workflow.UPDATE_STATES">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">UPDATE_STATES</code><em class="property"> = ('draft',)</em><a class="headerlink" href="#pyams_content.workflow.UPDATE_STATES" title="Permalink to this definition">¶</a></dt>
+<dd><p>Default state available to contributors in update mode</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.workflow.WorkflowStateLabelAdapter">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.</code><code class="descname">WorkflowStateLabelAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.WorkflowStateLabelAdapter" 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>Generic state label adapter</p>
+<dl class="staticmethod">
+<dt id="pyams_content.workflow.WorkflowStateLabelAdapter.get_label">
+<em class="property">static </em><code class="descname">get_label</code><span class="sig-paren">(</span><em>content</em>, <em>request=None</em>, <em>format=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.WorkflowStateLabelAdapter.get_label" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content.workflow.WorkflowUtility">
+<em class="property">class </em><code class="descclassname">pyams_content.workflow.</code><code class="descname">WorkflowUtility</code><a class="headerlink" href="#pyams_content.workflow.WorkflowUtility" 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>PyAMS default workflow utility</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.archive_action">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">archive_action</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.archive_action" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove readers when a content is archived</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_backdraft_content">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_backdraft_content</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_backdraft_content" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if content can return to DRAFT state</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_cancel_operation">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_cancel_operation</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_cancel_operation" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if we can cancel a request</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_create_new_version">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_create_new_version</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_create_new_version" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if we can create a new version</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_delete_version">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_delete_version</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_delete_version" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if we can delete a draft version</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_manage_content">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_manage_content</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_manage_content" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if a manager can handle content</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_propose_content">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_propose_content</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_propose_content" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if a content can be proposed</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.can_retire_content">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">can_retire_content</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.can_retire_content" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if already published content can return to RETIRED state</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.clone_action">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">clone_action</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.clone_action" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create new version</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.delete_action">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">delete_action</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.delete_action" title="Permalink to this definition">¶</a></dt>
+<dd><p>Delete draft version, and parent if single version</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content.workflow.publish_action">
+<code class="descclassname">pyams_content.workflow.</code><code class="descname">publish_action</code><span class="sig-paren">(</span><em>wf</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.workflow.publish_action" title="Permalink to this definition">¶</a></dt>
+<dd><p>Publish version</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_content.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_content.workflow.interfaces">pyams_content.workflow.interfaces module</a></li>
+<li><a class="reference internal" href="#module-pyams_content.workflow.notify">pyams_content.workflow.notify module</a></li>
+<li><a class="reference internal" href="#module-pyams_content.workflow.task">pyams_content.workflow.task module</a></li>
+<li><a class="reference internal" href="#module-pyams_content.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