1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_workflow.interfaces package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <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" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-workflow-interfaces-package"> |
|
54 <h1>pyams_workflow.interfaces package<a class="headerlink" href="#pyams-workflow-interfaces-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_workflow.interfaces"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_workflow.interfaces" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="exception"> |
|
58 <dt id="pyams_workflow.interfaces.AmbiguousTransitionError"> |
|
59 <em class="property">exception </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">AmbiguousTransitionError</code><span class="sig-paren">(</span><em>source</em>, <em>destination</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.AmbiguousTransitionError" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Bases: <a class="reference internal" href="#pyams_workflow.interfaces.InvalidTransitionError" title="pyams_workflow.interfaces.InvalidTransitionError"><code class="xref py py-class docutils literal"><span class="pre">pyams_workflow.interfaces.InvalidTransitionError</span></code></a></p> |
|
61 <p>Exception raised when required transition is ambiguous</p> |
|
62 </dd></dl> |
|
63 |
|
64 <dl class="exception"> |
|
65 <dt id="pyams_workflow.interfaces.ConditionFailedError"> |
|
66 <em class="property">exception </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">ConditionFailedError</code><a class="headerlink" href="#pyams_workflow.interfaces.ConditionFailedError" title="Permalink to this definition">¶</a></dt> |
|
67 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p> |
|
68 <p>Exception raised when transition condition failed</p> |
|
69 </dd></dl> |
|
70 |
|
71 <dl class="exception"> |
|
72 <dt id="pyams_workflow.interfaces.InvalidTransitionError"> |
|
73 <em class="property">exception </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">InvalidTransitionError</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.InvalidTransitionError" title="Permalink to this definition">¶</a></dt> |
|
74 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p> |
|
75 <p>Base transition error</p> |
|
76 </dd></dl> |
|
77 |
|
78 <dl class="exception"> |
|
79 <dt id="pyams_workflow.interfaces.NoTransitionAvailableError"> |
|
80 <em class="property">exception </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">NoTransitionAvailableError</code><span class="sig-paren">(</span><em>source</em>, <em>destination</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.NoTransitionAvailableError" title="Permalink to this definition">¶</a></dt> |
|
81 <dd><p>Bases: <a class="reference internal" href="#pyams_workflow.interfaces.InvalidTransitionError" title="pyams_workflow.interfaces.InvalidTransitionError"><code class="xref py py-class docutils literal"><span class="pre">pyams_workflow.interfaces.InvalidTransitionError</span></code></a></p> |
|
82 <p>Exception raised when there is not available transition</p> |
|
83 </dd></dl> |
|
84 |
|
85 <dl class="class"> |
|
86 <dt id="pyams_workflow.interfaces.ObjectClonedEvent"> |
|
87 <em class="property">class </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">ObjectClonedEvent</code><span class="sig-paren">(</span><em>object</em>, <em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.ObjectClonedEvent" title="Permalink to this definition">¶</a></dt> |
|
88 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.lifecycleevent.ObjectCreatedEvent</span></code></p> |
|
89 <p>Object cloned event</p> |
|
90 </dd></dl> |
|
91 |
|
92 <dl class="exception"> |
|
93 <dt id="pyams_workflow.interfaces.VersionError"> |
|
94 <em class="property">exception </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">VersionError</code><a class="headerlink" href="#pyams_workflow.interfaces.VersionError" title="Permalink to this definition">¶</a></dt> |
|
95 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p> |
|
96 <p>Versions management error</p> |
|
97 </dd></dl> |
|
98 |
|
99 <dl class="class"> |
|
100 <dt id="pyams_workflow.interfaces.WorkflowTransitionEvent"> |
|
101 <em class="property">class </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">WorkflowTransitionEvent</code><span class="sig-paren">(</span><em>object</em>, <em>workflow</em>, <em>principal</em>, <em>source</em>, <em>destination</em>, <em>transition</em>, <em>comment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.WorkflowTransitionEvent" title="Permalink to this definition">¶</a></dt> |
|
102 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.interface.interfaces.ObjectEvent</span></code></p> |
|
103 <p>Workflow transition event</p> |
|
104 </dd></dl> |
|
105 |
|
106 <dl class="class"> |
|
107 <dt id="pyams_workflow.interfaces.WorkflowVersionTransitionEvent"> |
|
108 <em class="property">class </em><code class="descclassname">pyams_workflow.interfaces.</code><code class="descname">WorkflowVersionTransitionEvent</code><span class="sig-paren">(</span><em>object</em>, <em>workflow</em>, <em>principal</em>, <em>old_object</em>, <em>source</em>, <em>destination</em>, <em>transition</em>, <em>comment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_workflow.interfaces.WorkflowVersionTransitionEvent" title="Permalink to this definition">¶</a></dt> |
|
109 <dd><p>Bases: <a class="reference internal" href="#pyams_workflow.interfaces.WorkflowTransitionEvent" title="pyams_workflow.interfaces.WorkflowTransitionEvent"><code class="xref py py-class docutils literal"><span class="pre">pyams_workflow.interfaces.WorkflowTransitionEvent</span></code></a></p> |
|
110 <p>Workflow version transition event</p> |
|
111 </dd></dl> |
|
112 |
|
113 </div> |
|
114 </div> |
|
115 |
|
116 |
|
117 </div> |
|
118 </div> |
|
119 </div> |
|
120 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
121 <div class="sphinxsidebarwrapper"> |
|
122 <h3><a href="index.html">Table Of Contents</a></h3> |
|
123 <ul> |
|
124 <li><a class="reference internal" href="#">pyams_workflow.interfaces package</a><ul> |
|
125 <li><a class="reference internal" href="#module-pyams_workflow.interfaces">Module contents</a></li> |
|
126 </ul> |
|
127 </li> |
|
128 </ul> |
|
129 |
|
130 <div id="searchbox" style="display: none" role="search"> |
|
131 <h3>Quick search</h3> |
|
132 <form class="search" action="search.html" method="get"> |
|
133 <div><input type="text" name="q" /></div> |
|
134 <div><input type="submit" value="Go" /></div> |
|
135 <input type="hidden" name="check_keywords" value="yes" /> |
|
136 <input type="hidden" name="area" value="default" /> |
|
137 </form> |
|
138 </div> |
|
139 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
140 </div> |
|
141 </div> |
|
142 <div class="clearer"></div> |
|
143 </div> |
|
144 <div class="related" role="navigation" aria-label="related navigation"> |
|
145 <h3>Navigation</h3> |
|
146 <ul> |
|
147 <li class="right" style="margin-right: 10px"> |
|
148 <a href="genindex.html" title="General Index" |
|
149 >index</a></li> |
|
150 <li class="right" > |
|
151 <a href="py-modindex.html" title="Python Module Index" |
|
152 >modules</a> |</li> |
|
153 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
154 </ul> |
|
155 </div> |
|
156 <div class="footer" role="contentinfo"> |
|
157 © Copyright 2017, Thierry Florac. |
|
158 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
159 </div> |
|
160 </body> |
|
161 </html> |
|