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 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-package"> |
|
54 <h1>pyams_workflow package<a class="headerlink" href="#pyams-workflow-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="subpackages"> |
|
56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
57 <div class="toctree-wrapper compound"> |
|
58 <ul> |
|
59 <li class="toctree-l1"><a class="reference internal" href="pyams_workflow.interfaces.html">pyams_workflow.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.interfaces.html#module-pyams_workflow.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_workflow.tests.html">pyams_workflow.tests package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#submodules">Submodules</a></li> |
|
65 <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> |
|
66 <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> |
|
67 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.tests.html#module-pyams_workflow.tests">Module contents</a></li> |
|
68 </ul> |
|
69 </li> |
|
70 <li class="toctree-l1"><a class="reference internal" href="pyams_workflow.zmi.html">pyams_workflow.zmi package</a><ul> |
|
71 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#subpackages">Subpackages</a><ul> |
|
72 <li class="toctree-l3"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html">pyams_workflow.zmi.viewlet package</a><ul> |
|
73 <li class="toctree-l4"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html#submodules">Submodules</a></li> |
|
74 <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> |
|
75 <li class="toctree-l4"><a class="reference internal" href="pyams_workflow.zmi.viewlet.html#module-pyams_workflow.zmi.viewlet">Module contents</a></li> |
|
76 </ul> |
|
77 </li> |
|
78 </ul> |
|
79 </li> |
|
80 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#submodules">Submodules</a></li> |
|
81 <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> |
|
82 <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> |
|
83 <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> |
|
84 <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> |
|
85 <li class="toctree-l2"><a class="reference internal" href="pyams_workflow.zmi.html#module-pyams_workflow.zmi">Module contents</a></li> |
|
86 </ul> |
|
87 </li> |
|
88 </ul> |
|
89 </div> |
|
90 </div> |
|
91 <div class="section" id="submodules"> |
|
92 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
93 </div> |
|
94 <div class="section" id="module-pyams_workflow.content"> |
|
95 <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> |
|
96 <dl class="class"> |
|
97 <dt id="pyams_workflow.content.WorkflowContentDisplayedDateVocabulary"> |
|
98 <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> |
|
99 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
100 <p>Workflow content displayed date vocabulary</p> |
|
101 </dd></dl> |
|
102 |
|
103 <dl class="class"> |
|
104 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo"> |
|
105 <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> |
|
106 <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> |
|
107 <p>Workflow content info</p> |
|
108 <dl class="attribute"> |
|
109 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.displayed_publication_date"> |
|
110 <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> |
|
111 <dd><p>Computed attributes based on schema fields</p> |
|
112 <p>Field properties provide default values, data validation and error messages |
|
113 based on data found in field meta-data.</p> |
|
114 <p>Note that FieldProperties cannot be used with slots. They can only |
|
115 be used for attributes stored in instance dictionaries.</p> |
|
116 </dd></dl> |
|
117 |
|
118 <dl class="attribute"> |
|
119 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.first_publication_date"> |
|
120 <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> |
|
121 <dd></dd></dl> |
|
122 |
|
123 <dl class="method"> |
|
124 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.is_published"> |
|
125 <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> |
|
126 <dd></dd></dl> |
|
127 |
|
128 <dl class="method"> |
|
129 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.is_visible"> |
|
130 <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> |
|
131 <dd></dd></dl> |
|
132 |
|
133 <dl class="attribute"> |
|
134 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication"> |
|
135 <code class="descname">publication</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication" title="Permalink to this definition">¶</a></dt> |
|
136 <dd></dd></dl> |
|
137 |
|
138 <dl class="attribute"> |
|
139 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_date"> |
|
140 <code class="descname">publication_date</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publication_date" title="Permalink to this definition">¶</a></dt> |
|
141 <dd></dd></dl> |
|
142 |
|
143 <dl class="attribute"> |
|
144 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_effective_date"> |
|
145 <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> |
|
146 <dd></dd></dl> |
|
147 |
|
148 <dl class="attribute"> |
|
149 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publication_expiration_date"> |
|
150 <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> |
|
151 <dd></dd></dl> |
|
152 |
|
153 <dl class="attribute"> |
|
154 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.publisher"> |
|
155 <code class="descname">publisher</code><a class="headerlink" href="#pyams_workflow.content.WorkflowContentPublicationInfo.publisher" title="Permalink to this definition">¶</a></dt> |
|
156 <dd><p>Computed attributes based on schema fields</p> |
|
157 <p>Field properties provide default values, data validation and error messages |
|
158 based on data found in field meta-data.</p> |
|
159 <p>Note that FieldProperties cannot be used with slots. They can only |
|
160 be used for attributes stored in instance dictionaries.</p> |
|
161 </dd></dl> |
|
162 |
|
163 <dl class="attribute"> |
|
164 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date"> |
|
165 <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> |
|
166 <dd><p>Computed attributes based on schema fields</p> |
|
167 <p>Field properties provide default values, data validation and error messages |
|
168 based on data found in field meta-data.</p> |
|
169 <p>Note that FieldProperties cannot be used with slots. They can only |
|
170 be used for attributes stored in instance dictionaries.</p> |
|
171 </dd></dl> |
|
172 |
|
173 <dl class="attribute"> |
|
174 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.push_end_date_index"> |
|
175 <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> |
|
176 <dd></dd></dl> |
|
177 |
|
178 <dl class="method"> |
|
179 <dt id="pyams_workflow.content.WorkflowContentPublicationInfo.reset"> |
|
180 <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> |
|
181 <dd></dd></dl> |
|
182 |
|
183 </dd></dl> |
|
184 |
|
185 <dl class="function"> |
|
186 <dt id="pyams_workflow.content.WorkflowContentPublicationInfoFactory"> |
|
187 <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> |
|
188 <dd><p>Workflow content info factory</p> |
|
189 </dd></dl> |
|
190 |
|
191 <dl class="function"> |
|
192 <dt id="pyams_workflow.content.handle_cloned_object"> |
|
193 <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> |
|
194 <dd><p>Add comment when an object is cloned</p> |
|
195 </dd></dl> |
|
196 |
|
197 <dl class="function"> |
|
198 <dt id="pyams_workflow.content.handle_cloned_publication_support"> |
|
199 <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> |
|
200 <dd><p>Reset publication info when an object is cloned</p> |
|
201 </dd></dl> |
|
202 |
|
203 </div> |
|
204 <div class="section" id="module-pyams_workflow.include"> |
|
205 <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> |
|
206 <dl class="function"> |
|
207 <dt id="pyams_workflow.include.include_package"> |
|
208 <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> |
|
209 <dd><p>Pyramid include</p> |
|
210 </dd></dl> |
|
211 |
|
212 </div> |
|
213 <div class="section" id="module-pyams_workflow.versions"> |
|
214 <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> |
|
215 <dl class="function"> |
|
216 <dt id="pyams_workflow.versions.WorkflowContentVersionsFactory"> |
|
217 <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> |
|
218 <dd><p>Workflow versions factory</p> |
|
219 </dd></dl> |
|
220 |
|
221 <dl class="class"> |
|
222 <dt id="pyams_workflow.versions.WorkflowHistoryItem"> |
|
223 <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> |
|
224 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
225 <p>Workflow history item</p> |
|
226 <dl class="attribute"> |
|
227 <dt id="pyams_workflow.versions.WorkflowHistoryItem.comment"> |
|
228 <code class="descname">comment</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.comment" title="Permalink to this definition">¶</a></dt> |
|
229 <dd><p>Computed attributes based on schema fields</p> |
|
230 <p>Field properties provide default values, data validation and error messages |
|
231 based on data found in field meta-data.</p> |
|
232 <p>Note that FieldProperties cannot be used with slots. They can only |
|
233 be used for attributes stored in instance dictionaries.</p> |
|
234 </dd></dl> |
|
235 |
|
236 <dl class="attribute"> |
|
237 <dt id="pyams_workflow.versions.WorkflowHistoryItem.date"> |
|
238 <code class="descname">date</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.date" title="Permalink to this definition">¶</a></dt> |
|
239 <dd><p>Computed attributes based on schema fields</p> |
|
240 <p>Field properties provide default values, data validation and error messages |
|
241 based on data found in field meta-data.</p> |
|
242 <p>Note that FieldProperties cannot be used with slots. They can only |
|
243 be used for attributes stored in instance dictionaries.</p> |
|
244 </dd></dl> |
|
245 |
|
246 <dl class="attribute"> |
|
247 <dt id="pyams_workflow.versions.WorkflowHistoryItem.principal"> |
|
248 <code class="descname">principal</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.principal" title="Permalink to this definition">¶</a></dt> |
|
249 <dd><p>Computed attributes based on schema fields</p> |
|
250 <p>Field properties provide default values, data validation and error messages |
|
251 based on data found in field meta-data.</p> |
|
252 <p>Note that FieldProperties cannot be used with slots. They can only |
|
253 be used for attributes stored in instance dictionaries.</p> |
|
254 </dd></dl> |
|
255 |
|
256 <dl class="attribute"> |
|
257 <dt id="pyams_workflow.versions.WorkflowHistoryItem.source_state"> |
|
258 <code class="descname">source_state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.source_state" title="Permalink to this definition">¶</a></dt> |
|
259 <dd><p>Computed attributes based on schema fields</p> |
|
260 <p>Field properties provide default values, data validation and error messages |
|
261 based on data found in field meta-data.</p> |
|
262 <p>Note that FieldProperties cannot be used with slots. They can only |
|
263 be used for attributes stored in instance dictionaries.</p> |
|
264 </dd></dl> |
|
265 |
|
266 <dl class="attribute"> |
|
267 <dt id="pyams_workflow.versions.WorkflowHistoryItem.source_version"> |
|
268 <code class="descname">source_version</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.source_version" title="Permalink to this definition">¶</a></dt> |
|
269 <dd><p>Computed attributes based on schema fields</p> |
|
270 <p>Field properties provide default values, data validation and error messages |
|
271 based on data found in field meta-data.</p> |
|
272 <p>Note that FieldProperties cannot be used with slots. They can only |
|
273 be used for attributes stored in instance dictionaries.</p> |
|
274 </dd></dl> |
|
275 |
|
276 <dl class="attribute"> |
|
277 <dt id="pyams_workflow.versions.WorkflowHistoryItem.target_state"> |
|
278 <code class="descname">target_state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.target_state" title="Permalink to this definition">¶</a></dt> |
|
279 <dd><p>Computed attributes based on schema fields</p> |
|
280 <p>Field properties provide default values, data validation and error messages |
|
281 based on data found in field meta-data.</p> |
|
282 <p>Note that FieldProperties cannot be used with slots. They can only |
|
283 be used for attributes stored in instance dictionaries.</p> |
|
284 </dd></dl> |
|
285 |
|
286 <dl class="attribute"> |
|
287 <dt id="pyams_workflow.versions.WorkflowHistoryItem.transition"> |
|
288 <code class="descname">transition</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.transition" title="Permalink to this definition">¶</a></dt> |
|
289 <dd><p>Computed attributes based on schema fields</p> |
|
290 <p>Field properties provide default values, data validation and error messages |
|
291 based on data found in field meta-data.</p> |
|
292 <p>Note that FieldProperties cannot be used with slots. They can only |
|
293 be used for attributes stored in instance dictionaries.</p> |
|
294 </dd></dl> |
|
295 |
|
296 <dl class="attribute"> |
|
297 <dt id="pyams_workflow.versions.WorkflowHistoryItem.transition_id"> |
|
298 <code class="descname">transition_id</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowHistoryItem.transition_id" title="Permalink to this definition">¶</a></dt> |
|
299 <dd><p>Computed attributes based on schema fields</p> |
|
300 <p>Field properties provide default values, data validation and error messages |
|
301 based on data found in field meta-data.</p> |
|
302 <p>Note that FieldProperties cannot be used with slots. They can only |
|
303 be used for attributes stored in instance dictionaries.</p> |
|
304 </dd></dl> |
|
305 |
|
306 </dd></dl> |
|
307 |
|
308 <dl class="class"> |
|
309 <dt id="pyams_workflow.versions.WorkflowVersionState"> |
|
310 <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> |
|
311 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
312 <p>Workflow managed content version object</p> |
|
313 <dl class="method"> |
|
314 <dt id="pyams_workflow.versions.WorkflowVersionState.get_first_state_date"> |
|
315 <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> |
|
316 <dd></dd></dl> |
|
317 |
|
318 <dl class="attribute"> |
|
319 <dt id="pyams_workflow.versions.WorkflowVersionState.state"> |
|
320 <code class="descname">state</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state" title="Permalink to this definition">¶</a></dt> |
|
321 <dd></dd></dl> |
|
322 |
|
323 <dl class="attribute"> |
|
324 <dt id="pyams_workflow.versions.WorkflowVersionState.state_date"> |
|
325 <code class="descname">state_date</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_date" title="Permalink to this definition">¶</a></dt> |
|
326 <dd></dd></dl> |
|
327 |
|
328 <dl class="attribute"> |
|
329 <dt id="pyams_workflow.versions.WorkflowVersionState.state_principal"> |
|
330 <code class="descname">state_principal</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_principal" title="Permalink to this definition">¶</a></dt> |
|
331 <dd></dd></dl> |
|
332 |
|
333 <dl class="attribute"> |
|
334 <dt id="pyams_workflow.versions.WorkflowVersionState.state_urgency"> |
|
335 <code class="descname">state_urgency</code><a class="headerlink" href="#pyams_workflow.versions.WorkflowVersionState.state_urgency" title="Permalink to this definition">¶</a></dt> |
|
336 <dd><p>Computed attributes based on schema fields</p> |
|
337 <p>Field properties provide default values, data validation and error messages |
|
338 based on data found in field meta-data.</p> |
|
339 <p>Note that FieldProperties cannot be used with slots. They can only |
|
340 be used for attributes stored in instance dictionaries.</p> |
|
341 </dd></dl> |
|
342 |
|
343 <dl class="attribute"> |
|
344 <dt id="pyams_workflow.versions.WorkflowVersionState.version_id"> |
|
345 <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> |
|
346 <dd></dd></dl> |
|
347 |
|
348 </dd></dl> |
|
349 |
|
350 <dl class="function"> |
|
351 <dt id="pyams_workflow.versions.WorkflowVersionStateFactory"> |
|
352 <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> |
|
353 <dd><p>Workflow content version state factory</p> |
|
354 </dd></dl> |
|
355 |
|
356 <dl class="function"> |
|
357 <dt id="pyams_workflow.versions.WorkflowVersionVersionsFactory"> |
|
358 <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> |
|
359 <dd><p>Workflow versions factory for version</p> |
|
360 </dd></dl> |
|
361 |
|
362 <dl class="class"> |
|
363 <dt id="pyams_workflow.versions.WorkflowVersions"> |
|
364 <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> |
|
365 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p> |
|
366 <p>Workflow versions adapter</p> |
|
367 <dl class="method"> |
|
368 <dt id="pyams_workflow.versions.WorkflowVersions.add_version"> |
|
369 <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> |
|
370 <dd></dd></dl> |
|
371 |
|
372 <dl class="method"> |
|
373 <dt id="pyams_workflow.versions.WorkflowVersions.get_last_versions"> |
|
374 <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> |
|
375 <dd></dd></dl> |
|
376 |
|
377 <dl class="method"> |
|
378 <dt id="pyams_workflow.versions.WorkflowVersions.get_version"> |
|
379 <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> |
|
380 <dd></dd></dl> |
|
381 |
|
382 <dl class="method"> |
|
383 <dt id="pyams_workflow.versions.WorkflowVersions.get_versions"> |
|
384 <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> |
|
385 <dd></dd></dl> |
|
386 |
|
387 <dl class="method"> |
|
388 <dt id="pyams_workflow.versions.WorkflowVersions.has_version"> |
|
389 <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> |
|
390 <dd></dd></dl> |
|
391 |
|
392 <dl class="method"> |
|
393 <dt id="pyams_workflow.versions.WorkflowVersions.remove_version"> |
|
394 <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> |
|
395 <dd></dd></dl> |
|
396 |
|
397 <dl class="method"> |
|
398 <dt id="pyams_workflow.versions.WorkflowVersions.set_state"> |
|
399 <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> |
|
400 <dd></dd></dl> |
|
401 |
|
402 </dd></dl> |
|
403 |
|
404 <dl class="class"> |
|
405 <dt id="pyams_workflow.versions.WorkflowVersionsSublocations"> |
|
406 <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> |
|
407 <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> |
|
408 <p>Workflow versions sub-locations</p> |
|
409 <dl class="method"> |
|
410 <dt id="pyams_workflow.versions.WorkflowVersionsSublocations.sublocations"> |
|
411 <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> |
|
412 <dd></dd></dl> |
|
413 |
|
414 </dd></dl> |
|
415 |
|
416 <dl class="class"> |
|
417 <dt id="pyams_workflow.versions.WorkflowVersionsTraverser"> |
|
418 <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> |
|
419 <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> |
|
420 <p>++versions++ namespace traverser</p> |
|
421 <dl class="method"> |
|
422 <dt id="pyams_workflow.versions.WorkflowVersionsTraverser.traverse"> |
|
423 <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> |
|
424 <dd></dd></dl> |
|
425 |
|
426 </dd></dl> |
|
427 |
|
428 <dl class="function"> |
|
429 <dt id="pyams_workflow.versions.handle_workflow_transition"> |
|
430 <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> |
|
431 <dd><p>Handle workflow transition</p> |
|
432 </dd></dl> |
|
433 |
|
434 <dl class="function"> |
|
435 <dt id="pyams_workflow.versions.handle_workflow_version_transition"> |
|
436 <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> |
|
437 <dd><p>Handle workflow version transition</p> |
|
438 </dd></dl> |
|
439 |
|
440 </div> |
|
441 <div class="section" id="module-pyams_workflow.workflow"> |
|
442 <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> |
|
443 <dl class="function"> |
|
444 <dt id="pyams_workflow.workflow.NullAction"> |
|
445 <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> |
|
446 <dd><p>Null action</p> |
|
447 </dd></dl> |
|
448 |
|
449 <dl class="function"> |
|
450 <dt id="pyams_workflow.workflow.NullCondition"> |
|
451 <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> |
|
452 <dd><p>Null condition</p> |
|
453 </dd></dl> |
|
454 |
|
455 <dl class="class"> |
|
456 <dt id="pyams_workflow.workflow.Transition"> |
|
457 <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> |
|
458 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
459 <p>Transition object</p> |
|
460 <p>A transition doesn’t make anything by itself. |
|
461 Everything is handled by the workflow utility</p> |
|
462 </dd></dl> |
|
463 |
|
464 <dl class="class"> |
|
465 <dt id="pyams_workflow.workflow.Workflow"> |
|
466 <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> |
|
467 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
468 <p>Workflow utility</p> |
|
469 <dl class="method"> |
|
470 <dt id="pyams_workflow.workflow.Workflow.get_state_label"> |
|
471 <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> |
|
472 <dd></dd></dl> |
|
473 |
|
474 <dl class="method"> |
|
475 <dt id="pyams_workflow.workflow.Workflow.get_transition"> |
|
476 <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> |
|
477 <dd></dd></dl> |
|
478 |
|
479 <dl class="method"> |
|
480 <dt id="pyams_workflow.workflow.Workflow.get_transition_by_id"> |
|
481 <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> |
|
482 <dd></dd></dl> |
|
483 |
|
484 <dl class="method"> |
|
485 <dt id="pyams_workflow.workflow.Workflow.get_transitions"> |
|
486 <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> |
|
487 <dd></dd></dl> |
|
488 |
|
489 <dl class="method"> |
|
490 <dt id="pyams_workflow.workflow.Workflow.refresh"> |
|
491 <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> |
|
492 <dd></dd></dl> |
|
493 |
|
494 </dd></dl> |
|
495 |
|
496 <dl class="class"> |
|
497 <dt id="pyams_workflow.workflow.WorkflowInfo"> |
|
498 <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> |
|
499 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
500 <p>Workflow info adapter</p> |
|
501 <dl class="method"> |
|
502 <dt id="pyams_workflow.workflow.WorkflowInfo.fire_automatic"> |
|
503 <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> |
|
504 <dd></dd></dl> |
|
505 |
|
506 <dl class="method"> |
|
507 <dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition"> |
|
508 <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> |
|
509 <dd></dd></dl> |
|
510 |
|
511 <dl class="method"> |
|
512 <dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition_for_versions"> |
|
513 <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> |
|
514 <dd></dd></dl> |
|
515 |
|
516 <dl class="method"> |
|
517 <dt id="pyams_workflow.workflow.WorkflowInfo.fire_transition_toward"> |
|
518 <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> |
|
519 <dd></dd></dl> |
|
520 |
|
521 <dl class="method"> |
|
522 <dt id="pyams_workflow.workflow.WorkflowInfo.get_automatic_transition_ids"> |
|
523 <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> |
|
524 <dd></dd></dl> |
|
525 |
|
526 <dl class="method"> |
|
527 <dt id="pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids"> |
|
528 <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> |
|
529 <dd></dd></dl> |
|
530 |
|
531 <dl class="method"> |
|
532 <dt id="pyams_workflow.workflow.WorkflowInfo.get_fireable_transition_ids_toward"> |
|
533 <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> |
|
534 <dd></dd></dl> |
|
535 |
|
536 <dl class="method"> |
|
537 <dt id="pyams_workflow.workflow.WorkflowInfo.get_manual_transition_ids"> |
|
538 <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> |
|
539 <dd></dd></dl> |
|
540 |
|
541 <dl class="method"> |
|
542 <dt id="pyams_workflow.workflow.WorkflowInfo.get_system_transition_ids"> |
|
543 <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> |
|
544 <dd></dd></dl> |
|
545 |
|
546 <dl class="method"> |
|
547 <dt id="pyams_workflow.workflow.WorkflowInfo.has_automatic_transitions"> |
|
548 <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> |
|
549 <dd></dd></dl> |
|
550 |
|
551 <dl class="method"> |
|
552 <dt id="pyams_workflow.workflow.WorkflowInfo.has_version"> |
|
553 <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> |
|
554 <dd></dd></dl> |
|
555 |
|
556 <dl class="attribute"> |
|
557 <dt id="pyams_workflow.workflow.WorkflowInfo.name"> |
|
558 <code class="descname">name</code><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.name" title="Permalink to this definition">¶</a></dt> |
|
559 <dd></dd></dl> |
|
560 |
|
561 <dl class="attribute"> |
|
562 <dt id="pyams_workflow.workflow.WorkflowInfo.parent"> |
|
563 <code class="descname">parent</code><a class="headerlink" href="#pyams_workflow.workflow.WorkflowInfo.parent" title="Permalink to this definition">¶</a></dt> |
|
564 <dd></dd></dl> |
|
565 |
|
566 </dd></dl> |
|
567 |
|
568 <dl class="class"> |
|
569 <dt id="pyams_workflow.workflow.WorkflowsVocabulary"> |
|
570 <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> |
|
571 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
572 <p>Workflows vocabulary</p> |
|
573 <dl class="attribute"> |
|
574 <dt id="pyams_workflow.workflow.WorkflowsVocabulary.interface"> |
|
575 <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> |
|
576 <dd></dd></dl> |
|
577 |
|
578 <dl class="attribute"> |
|
579 <dt id="pyams_workflow.workflow.WorkflowsVocabulary.nameOnly"> |
|
580 <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> |
|
581 <dd></dd></dl> |
|
582 |
|
583 </dd></dl> |
|
584 |
|
585 <dl class="function"> |
|
586 <dt id="pyams_workflow.workflow.granted_permission"> |
|
587 <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> |
|
588 <dd></dd></dl> |
|
589 |
|
590 </div> |
|
591 <div class="section" id="module-pyams_workflow"> |
|
592 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_workflow" title="Permalink to this headline">¶</a></h2> |
|
593 <dl class="function"> |
|
594 <dt id="pyams_workflow.includeme"> |
|
595 <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> |
|
596 <dd><p>Pyramid include</p> |
|
597 </dd></dl> |
|
598 |
|
599 </div> |
|
600 </div> |
|
601 |
|
602 |
|
603 </div> |
|
604 </div> |
|
605 </div> |
|
606 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
607 <div class="sphinxsidebarwrapper"> |
|
608 <h3><a href="index.html">Table Of Contents</a></h3> |
|
609 <ul> |
|
610 <li><a class="reference internal" href="#">pyams_workflow package</a><ul> |
|
611 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
612 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
613 <li><a class="reference internal" href="#module-pyams_workflow.content">pyams_workflow.content module</a></li> |
|
614 <li><a class="reference internal" href="#module-pyams_workflow.include">pyams_workflow.include module</a></li> |
|
615 <li><a class="reference internal" href="#module-pyams_workflow.versions">pyams_workflow.versions module</a></li> |
|
616 <li><a class="reference internal" href="#module-pyams_workflow.workflow">pyams_workflow.workflow module</a></li> |
|
617 <li><a class="reference internal" href="#module-pyams_workflow">Module contents</a></li> |
|
618 </ul> |
|
619 </li> |
|
620 </ul> |
|
621 |
|
622 <div id="searchbox" style="display: none" role="search"> |
|
623 <h3>Quick search</h3> |
|
624 <form class="search" action="search.html" method="get"> |
|
625 <div><input type="text" name="q" /></div> |
|
626 <div><input type="submit" value="Go" /></div> |
|
627 <input type="hidden" name="check_keywords" value="yes" /> |
|
628 <input type="hidden" name="area" value="default" /> |
|
629 </form> |
|
630 </div> |
|
631 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
632 </div> |
|
633 </div> |
|
634 <div class="clearer"></div> |
|
635 </div> |
|
636 <div class="related" role="navigation" aria-label="related navigation"> |
|
637 <h3>Navigation</h3> |
|
638 <ul> |
|
639 <li class="right" style="margin-right: 10px"> |
|
640 <a href="genindex.html" title="General Index" |
|
641 >index</a></li> |
|
642 <li class="right" > |
|
643 <a href="py-modindex.html" title="Python Module Index" |
|
644 >modules</a> |</li> |
|
645 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
646 </ul> |
|
647 </div> |
|
648 <div class="footer" role="contentinfo"> |
|
649 © Copyright 2017, Thierry Florac. |
|
650 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
651 </div> |
|
652 </body> |
|
653 </html> |
|