|
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_content.shared.common 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-content-shared-common-package"> |
|
54 <h1>pyams_content.shared.common package<a class="headerlink" href="#pyams-content-shared-common-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_content.shared.common.interfaces.html">pyams_content.shared.common.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.interfaces.html#submodules">Submodules</a></li> |
|
61 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.interfaces.html#module-pyams_content.shared.common.interfaces.types">pyams_content.shared.common.interfaces.types module</a></li> |
|
62 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.interfaces.html#module-pyams_content.shared.common.interfaces.zmi">pyams_content.shared.common.interfaces.zmi module</a></li> |
|
63 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.interfaces.html#module-pyams_content.shared.common.interfaces">Module contents</a></li> |
|
64 </ul> |
|
65 </li> |
|
66 <li class="toctree-l1"><a class="reference internal" href="pyams_content.shared.common.zmi.html">pyams_content.shared.common.zmi package</a><ul> |
|
67 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#submodules">Submodules</a></li> |
|
68 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.dashboard">pyams_content.shared.common.zmi.dashboard module</a></li> |
|
69 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.header">pyams_content.shared.common.zmi.header module</a></li> |
|
70 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.i18n">pyams_content.shared.common.zmi.i18n module</a></li> |
|
71 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.manager">pyams_content.shared.common.zmi.manager module</a></li> |
|
72 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.owner">pyams_content.shared.common.zmi.owner module</a></li> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.properties">pyams_content.shared.common.zmi.properties module</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.search">pyams_content.shared.common.zmi.search module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.security">pyams_content.shared.common.zmi.security module</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.site">pyams_content.shared.common.zmi.site module</a></li> |
|
77 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.summary">pyams_content.shared.common.zmi.summary module</a></li> |
|
78 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.types">pyams_content.shared.common.zmi.types module</a></li> |
|
79 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi.workflow">pyams_content.shared.common.zmi.workflow module</a></li> |
|
80 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.common.zmi.html#module-pyams_content.shared.common.zmi">Module contents</a></li> |
|
81 </ul> |
|
82 </li> |
|
83 </ul> |
|
84 </div> |
|
85 </div> |
|
86 <div class="section" id="submodules"> |
|
87 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
88 </div> |
|
89 <div class="section" id="module-pyams_content.shared.common.manager"> |
|
90 <span id="pyams-content-shared-common-manager-module"></span><h2>pyams_content.shared.common.manager module<a class="headerlink" href="#module-pyams_content.shared.common.manager" title="Permalink to this headline">¶</a></h2> |
|
91 <dl class="class"> |
|
92 <dt id="pyams_content.shared.common.manager.BaseSharedTool"> |
|
93 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.manager.</code><code class="descname">BaseSharedTool</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool" title="Permalink to this definition">¶</a></dt> |
|
94 <dd><p>Bases: <a class="reference internal" href="pyams_security.html#pyams_security.security.ProtectedObject" title="pyams_security.security.ProtectedObject"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.security.ProtectedObject</span></code></a>, <a class="reference internal" href="pyams_i18n.html#pyams_i18n.content.I18nManagerMixin" title="pyams_i18n.content.I18nManagerMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_i18n.content.I18nManagerMixin</span></code></a></p> |
|
95 <p>Base shared tool class</p> |
|
96 <dl class="attribute"> |
|
97 <dt id="pyams_content.shared.common.manager.BaseSharedTool.contributors"> |
|
98 <code class="descname">contributors</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.contributors" title="Permalink to this definition">¶</a></dt> |
|
99 <dd><p>Custom field property used to handle role principals</p> |
|
100 </dd></dl> |
|
101 |
|
102 <dl class="attribute"> |
|
103 <dt id="pyams_content.shared.common.manager.BaseSharedTool.managers"> |
|
104 <code class="descname">managers</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.managers" title="Permalink to this definition">¶</a></dt> |
|
105 <dd><p>Custom field property used to handle role principals</p> |
|
106 </dd></dl> |
|
107 |
|
108 <dl class="attribute"> |
|
109 <dt id="pyams_content.shared.common.manager.BaseSharedTool.pilots"> |
|
110 <code class="descname">pilots</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.pilots" title="Permalink to this definition">¶</a></dt> |
|
111 <dd><p>Custom field property used to handle role principals</p> |
|
112 </dd></dl> |
|
113 |
|
114 <dl class="attribute"> |
|
115 <dt id="pyams_content.shared.common.manager.BaseSharedTool.roles_interface"> |
|
116 <code class="descname">roles_interface</code><em class="property"> = <InterfaceClass pyams_content.shared.common.interfaces.ISharedToolRoles></em><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.roles_interface" title="Permalink to this definition">¶</a></dt> |
|
117 <dd></dd></dl> |
|
118 |
|
119 <dl class="attribute"> |
|
120 <dt id="pyams_content.shared.common.manager.BaseSharedTool.shared_content_workflow"> |
|
121 <code class="descname">shared_content_workflow</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.shared_content_workflow" title="Permalink to this definition">¶</a></dt> |
|
122 <dd><p>Computed attributes based on schema fields</p> |
|
123 <p>Field properties provide default values, data validation and error messages |
|
124 based on data found in field meta-data.</p> |
|
125 <p>Note that FieldProperties cannot be used with slots. They can only |
|
126 be used for attributes stored in instance dictionaries.</p> |
|
127 </dd></dl> |
|
128 |
|
129 <dl class="attribute"> |
|
130 <dt id="pyams_content.shared.common.manager.BaseSharedTool.short_name"> |
|
131 <code class="descname">short_name</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.short_name" title="Permalink to this definition">¶</a></dt> |
|
132 <dd><p>Computed attributes based on schema fields</p> |
|
133 <p>Field properties provide default values, data validation and error messages |
|
134 based on data found in field meta-data.</p> |
|
135 <p>Note that FieldProperties cannot be used with slots. They can only |
|
136 be used for attributes stored in instance dictionaries.</p> |
|
137 </dd></dl> |
|
138 |
|
139 <dl class="attribute"> |
|
140 <dt id="pyams_content.shared.common.manager.BaseSharedTool.title"> |
|
141 <code class="descname">title</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.title" title="Permalink to this definition">¶</a></dt> |
|
142 <dd><p>Computed attributes based on schema fields</p> |
|
143 <p>Field properties provide default values, data validation and error messages |
|
144 based on data found in field meta-data.</p> |
|
145 <p>Note that FieldProperties cannot be used with slots. They can only |
|
146 be used for attributes stored in instance dictionaries.</p> |
|
147 </dd></dl> |
|
148 |
|
149 <dl class="attribute"> |
|
150 <dt id="pyams_content.shared.common.manager.BaseSharedTool.webmasters"> |
|
151 <code class="descname">webmasters</code><a class="headerlink" href="#pyams_content.shared.common.manager.BaseSharedTool.webmasters" title="Permalink to this definition">¶</a></dt> |
|
152 <dd><p>Custom field property used to handle role principals</p> |
|
153 </dd></dl> |
|
154 |
|
155 </dd></dl> |
|
156 |
|
157 <dl class="class"> |
|
158 <dt id="pyams_content.shared.common.manager.SharedTool"> |
|
159 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.manager.</code><code class="descname">SharedTool</code><a class="headerlink" href="#pyams_content.shared.common.manager.SharedTool" title="Permalink to this definition">¶</a></dt> |
|
160 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code>, <a class="reference internal" href="#pyams_content.shared.common.manager.BaseSharedTool" title="pyams_content.shared.common.manager.BaseSharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.BaseSharedTool</span></code></a></p> |
|
161 <p>Shared tool class</p> |
|
162 <dl class="attribute"> |
|
163 <dt id="pyams_content.shared.common.manager.SharedTool.shared_content_factory"> |
|
164 <code class="descname">shared_content_factory</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.shared.common.manager.SharedTool.shared_content_factory" title="Permalink to this definition">¶</a></dt> |
|
165 <dd></dd></dl> |
|
166 |
|
167 <dl class="attribute"> |
|
168 <dt id="pyams_content.shared.common.manager.SharedTool.shared_content_type"> |
|
169 <code class="descname">shared_content_type</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.shared.common.manager.SharedTool.shared_content_type" title="Permalink to this definition">¶</a></dt> |
|
170 <dd></dd></dl> |
|
171 |
|
172 </dd></dl> |
|
173 |
|
174 <dl class="class"> |
|
175 <dt id="pyams_content.shared.common.manager.SharedToolContainer"> |
|
176 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.manager.</code><code class="descname">SharedToolContainer</code><a class="headerlink" href="#pyams_content.shared.common.manager.SharedToolContainer" title="Permalink to this definition">¶</a></dt> |
|
177 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p> |
|
178 <p>Shared tools container</p> |
|
179 <dl class="attribute"> |
|
180 <dt id="pyams_content.shared.common.manager.SharedToolContainer.short_name"> |
|
181 <code class="descname">short_name</code><a class="headerlink" href="#pyams_content.shared.common.manager.SharedToolContainer.short_name" title="Permalink to this definition">¶</a></dt> |
|
182 <dd><p>Computed attributes based on schema fields</p> |
|
183 <p>Field properties provide default values, data validation and error messages |
|
184 based on data found in field meta-data.</p> |
|
185 <p>Note that FieldProperties cannot be used with slots. They can only |
|
186 be used for attributes stored in instance dictionaries.</p> |
|
187 </dd></dl> |
|
188 |
|
189 <dl class="attribute"> |
|
190 <dt id="pyams_content.shared.common.manager.SharedToolContainer.title"> |
|
191 <code class="descname">title</code><a class="headerlink" href="#pyams_content.shared.common.manager.SharedToolContainer.title" title="Permalink to this definition">¶</a></dt> |
|
192 <dd><p>Computed attributes based on schema fields</p> |
|
193 <p>Field properties provide default values, data validation and error messages |
|
194 based on data found in field meta-data.</p> |
|
195 <p>Note that FieldProperties cannot be used with slots. They can only |
|
196 be used for attributes stored in instance dictionaries.</p> |
|
197 </dd></dl> |
|
198 |
|
199 </dd></dl> |
|
200 |
|
201 <dl class="function"> |
|
202 <dt id="pyams_content.shared.common.manager.SharedToolWorkflowAdapter"> |
|
203 <code class="descclassname">pyams_content.shared.common.manager.</code><code class="descname">SharedToolWorkflowAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.manager.SharedToolWorkflowAdapter" title="Permalink to this definition">¶</a></dt> |
|
204 <dd><p>Shared tool workflow adapter</p> |
|
205 </dd></dl> |
|
206 |
|
207 </div> |
|
208 <div class="section" id="module-pyams_content.shared.common.review"> |
|
209 <span id="pyams-content-shared-common-review-module"></span><h2>pyams_content.shared.common.review module<a class="headerlink" href="#module-pyams_content.shared.common.review" title="Permalink to this headline">¶</a></h2> |
|
210 </div> |
|
211 <div class="section" id="module-pyams_content.shared.common.security"> |
|
212 <span id="pyams-content-shared-common-security-module"></span><h2>pyams_content.shared.common.security module<a class="headerlink" href="#module-pyams_content.shared.common.security" title="Permalink to this headline">¶</a></h2> |
|
213 <dl class="function"> |
|
214 <dt id="pyams_content.shared.common.security.SharedContentManagerRestrictions"> |
|
215 <code class="descclassname">pyams_content.shared.common.security.</code><code class="descname">SharedContentManagerRestrictions</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedContentManagerRestrictions" title="Permalink to this definition">¶</a></dt> |
|
216 <dd><p>Shared tool manager restrictions</p> |
|
217 </dd></dl> |
|
218 |
|
219 <dl class="class"> |
|
220 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo"> |
|
221 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.security.</code><code class="descname">SharedToolManagerRestrictionInfo</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo" title="Permalink to this definition">¶</a></dt> |
|
222 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
223 <p>Shared tool manager restriction info</p> |
|
224 <dl class="method"> |
|
225 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.check_access"> |
|
226 <code class="descname">check_access</code><span class="sig-paren">(</span><em>context</em>, <em>permission='pyams.ManageContent'</em>, <em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.check_access" title="Permalink to this definition">¶</a></dt> |
|
227 <dd></dd></dl> |
|
228 |
|
229 <dl class="attribute"> |
|
230 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.owners"> |
|
231 <code class="descname">owners</code><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.owners" title="Permalink to this definition">¶</a></dt> |
|
232 <dd><p>Computed attributes based on schema fields</p> |
|
233 <p>Field properties provide default values, data validation and error messages |
|
234 based on data found in field meta-data.</p> |
|
235 <p>Note that FieldProperties cannot be used with slots. They can only |
|
236 be used for attributes stored in instance dictionaries.</p> |
|
237 </dd></dl> |
|
238 |
|
239 <dl class="attribute"> |
|
240 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.principal_id"> |
|
241 <code class="descname">principal_id</code><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.principal_id" title="Permalink to this definition">¶</a></dt> |
|
242 <dd><p>Computed attributes based on schema fields</p> |
|
243 <p>Field properties provide default values, data validation and error messages |
|
244 based on data found in field meta-data.</p> |
|
245 <p>Note that FieldProperties cannot be used with slots. They can only |
|
246 be used for attributes stored in instance dictionaries.</p> |
|
247 </dd></dl> |
|
248 |
|
249 <dl class="attribute"> |
|
250 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.restricted_contents"> |
|
251 <code class="descname">restricted_contents</code><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.restricted_contents" title="Permalink to this definition">¶</a></dt> |
|
252 <dd><p>Computed attributes based on schema fields</p> |
|
253 <p>Field properties provide default values, data validation and error messages |
|
254 based on data found in field meta-data.</p> |
|
255 <p>Note that FieldProperties cannot be used with slots. They can only |
|
256 be used for attributes stored in instance dictionaries.</p> |
|
257 </dd></dl> |
|
258 |
|
259 <dl class="attribute"> |
|
260 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.restriction_interface"> |
|
261 <code class="descname">restriction_interface</code><em class="property"> = <InterfaceClass pyams_content.shared.common.interfaces.IManagerRestrictionInfo></em><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionInfo.restriction_interface" title="Permalink to this definition">¶</a></dt> |
|
262 <dd></dd></dl> |
|
263 |
|
264 </dd></dl> |
|
265 |
|
266 <dl class="class"> |
|
267 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictions"> |
|
268 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.security.</code><code class="descname">SharedToolManagerRestrictions</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictions" title="Permalink to this definition">¶</a></dt> |
|
269 <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> |
|
270 <p>Shared tool manager restrictions</p> |
|
271 <dl class="method"> |
|
272 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictions.drop_restrictions"> |
|
273 <code class="descname">drop_restrictions</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictions.drop_restrictions" title="Permalink to this definition">¶</a></dt> |
|
274 <dd></dd></dl> |
|
275 |
|
276 <dl class="method"> |
|
277 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictions.get_restrictions"> |
|
278 <code class="descname">get_restrictions</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictions.get_restrictions" title="Permalink to this definition">¶</a></dt> |
|
279 <dd></dd></dl> |
|
280 |
|
281 <dl class="method"> |
|
282 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictions.set_restrictions"> |
|
283 <code class="descname">set_restrictions</code><span class="sig-paren">(</span><em>principal</em>, <em>restrictions</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictions.set_restrictions" title="Permalink to this definition">¶</a></dt> |
|
284 <dd></dd></dl> |
|
285 |
|
286 </dd></dl> |
|
287 |
|
288 <dl class="function"> |
|
289 <dt id="pyams_content.shared.common.security.SharedToolManagerRestrictionsFactory"> |
|
290 <code class="descclassname">pyams_content.shared.common.security.</code><code class="descname">SharedToolManagerRestrictionsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.SharedToolManagerRestrictionsFactory" title="Permalink to this definition">¶</a></dt> |
|
291 <dd><p>Default shared tool manager restrictions factory</p> |
|
292 </dd></dl> |
|
293 |
|
294 <dl class="function"> |
|
295 <dt id="pyams_content.shared.common.security.handle_revoked_manager_role"> |
|
296 <code class="descclassname">pyams_content.shared.common.security.</code><code class="descname">handle_revoked_manager_role</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.security.handle_revoked_manager_role" title="Permalink to this definition">¶</a></dt> |
|
297 <dd><p>Handle revoked manager role</p> |
|
298 </dd></dl> |
|
299 |
|
300 </div> |
|
301 <div class="section" id="module-pyams_content.shared.common.types"> |
|
302 <span id="pyams-content-shared-common-types-module"></span><h2>pyams_content.shared.common.types module<a class="headerlink" href="#module-pyams_content.shared.common.types" title="Permalink to this headline">¶</a></h2> |
|
303 <dl class="class"> |
|
304 <dt id="pyams_content.shared.common.types.BaseDataType"> |
|
305 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">BaseDataType</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType" title="Permalink to this definition">¶</a></dt> |
|
306 <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> |
|
307 <p>Base data type</p> |
|
308 <dl class="attribute"> |
|
309 <dt id="pyams_content.shared.common.types.BaseDataType.label"> |
|
310 <code class="descname">label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.label" title="Permalink to this definition">¶</a></dt> |
|
311 <dd><p>Computed attributes based on schema fields</p> |
|
312 <p>Field properties provide default values, data validation and error messages |
|
313 based on data found in field meta-data.</p> |
|
314 <p>Note that FieldProperties cannot be used with slots. They can only |
|
315 be used for attributes stored in instance dictionaries.</p> |
|
316 </dd></dl> |
|
317 |
|
318 <dl class="attribute"> |
|
319 <dt id="pyams_content.shared.common.types.BaseDataType.navigation_label"> |
|
320 <code class="descname">navigation_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.navigation_label" title="Permalink to this definition">¶</a></dt> |
|
321 <dd><p>Computed attributes based on schema fields</p> |
|
322 <p>Field properties provide default values, data validation and error messages |
|
323 based on data found in field meta-data.</p> |
|
324 <p>Note that FieldProperties cannot be used with slots. They can only |
|
325 be used for attributes stored in instance dictionaries.</p> |
|
326 </dd></dl> |
|
327 |
|
328 <dl class="attribute"> |
|
329 <dt id="pyams_content.shared.common.types.BaseDataType.next_label"> |
|
330 <code class="descname">next_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.next_label" title="Permalink to this definition">¶</a></dt> |
|
331 <dd><p>Computed attributes based on schema fields</p> |
|
332 <p>Field properties provide default values, data validation and error messages |
|
333 based on data found in field meta-data.</p> |
|
334 <p>Note that FieldProperties cannot be used with slots. They can only |
|
335 be used for attributes stored in instance dictionaries.</p> |
|
336 </dd></dl> |
|
337 |
|
338 <dl class="attribute"> |
|
339 <dt id="pyams_content.shared.common.types.BaseDataType.pictogram"> |
|
340 <code class="descname">pictogram</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.pictogram" title="Permalink to this definition">¶</a></dt> |
|
341 <dd><p>I18n property class used to handle files</p> |
|
342 </dd></dl> |
|
343 |
|
344 <dl class="attribute"> |
|
345 <dt id="pyams_content.shared.common.types.BaseDataType.seeall_label"> |
|
346 <code class="descname">seeall_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.seeall_label" title="Permalink to this definition">¶</a></dt> |
|
347 <dd><p>Computed attributes based on schema fields</p> |
|
348 <p>Field properties provide default values, data validation and error messages |
|
349 based on data found in field meta-data.</p> |
|
350 <p>Note that FieldProperties cannot be used with slots. They can only |
|
351 be used for attributes stored in instance dictionaries.</p> |
|
352 </dd></dl> |
|
353 |
|
354 <dl class="attribute"> |
|
355 <dt id="pyams_content.shared.common.types.BaseDataType.seealso_label"> |
|
356 <code class="descname">seealso_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.seealso_label" title="Permalink to this definition">¶</a></dt> |
|
357 <dd><p>Computed attributes based on schema fields</p> |
|
358 <p>Field properties provide default values, data validation and error messages |
|
359 based on data found in field meta-data.</p> |
|
360 <p>Note that FieldProperties cannot be used with slots. They can only |
|
361 be used for attributes stored in instance dictionaries.</p> |
|
362 </dd></dl> |
|
363 |
|
364 <dl class="attribute"> |
|
365 <dt id="pyams_content.shared.common.types.BaseDataType.single_label"> |
|
366 <code class="descname">single_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.single_label" title="Permalink to this definition">¶</a></dt> |
|
367 <dd><p>Computed attributes based on schema fields</p> |
|
368 <p>Field properties provide default values, data validation and error messages |
|
369 based on data found in field meta-data.</p> |
|
370 <p>Note that FieldProperties cannot be used with slots. They can only |
|
371 be used for attributes stored in instance dictionaries.</p> |
|
372 </dd></dl> |
|
373 |
|
374 <dl class="attribute"> |
|
375 <dt id="pyams_content.shared.common.types.BaseDataType.tabfolder_label"> |
|
376 <code class="descname">tabfolder_label</code><a class="headerlink" href="#pyams_content.shared.common.types.BaseDataType.tabfolder_label" title="Permalink to this definition">¶</a></dt> |
|
377 <dd><p>Computed attributes based on schema fields</p> |
|
378 <p>Field properties provide default values, data validation and error messages |
|
379 based on data found in field meta-data.</p> |
|
380 <p>Note that FieldProperties cannot be used with slots. They can only |
|
381 be used for attributes stored in instance dictionaries.</p> |
|
382 </dd></dl> |
|
383 |
|
384 </dd></dl> |
|
385 |
|
386 <dl class="class"> |
|
387 <dt id="pyams_content.shared.common.types.BaseDatatypePermissionChecker"> |
|
388 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">BaseDatatypePermissionChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.BaseDatatypePermissionChecker" title="Permalink to this definition">¶</a></dt> |
|
389 <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> |
|
390 <p>Base data type permission checker</p> |
|
391 <dl class="attribute"> |
|
392 <dt id="pyams_content.shared.common.types.BaseDatatypePermissionChecker.edit_permission"> |
|
393 <code class="descname">edit_permission</code><em class="property"> = 'pyams.ManageTool'</em><a class="headerlink" href="#pyams_content.shared.common.types.BaseDatatypePermissionChecker.edit_permission" title="Permalink to this definition">¶</a></dt> |
|
394 <dd></dd></dl> |
|
395 |
|
396 </dd></dl> |
|
397 |
|
398 <dl class="class"> |
|
399 <dt id="pyams_content.shared.common.types.DataType"> |
|
400 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">DataType</code><a class="headerlink" href="#pyams_content.shared.common.types.DataType" title="Permalink to this definition">¶</a></dt> |
|
401 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.common.types.BaseDataType" title="pyams_content.shared.common.types.BaseDataType"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.types.BaseDataType</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.ordered.OrderedContainer</span></code></p> |
|
402 <p>Data type persistent class</p> |
|
403 <dl class="attribute"> |
|
404 <dt id="pyams_content.shared.common.types.DataType.field_names"> |
|
405 <code class="descname">field_names</code><a class="headerlink" href="#pyams_content.shared.common.types.DataType.field_names" title="Permalink to this definition">¶</a></dt> |
|
406 <dd><p>Computed attributes based on schema fields</p> |
|
407 <p>Field properties provide default values, data validation and error messages |
|
408 based on data found in field meta-data.</p> |
|
409 <p>Note that FieldProperties cannot be used with slots. They can only |
|
410 be used for attributes stored in instance dictionaries.</p> |
|
411 </dd></dl> |
|
412 |
|
413 </dd></dl> |
|
414 |
|
415 <dl class="class"> |
|
416 <dt id="pyams_content.shared.common.types.SubType"> |
|
417 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">SubType</code><a class="headerlink" href="#pyams_content.shared.common.types.SubType" title="Permalink to this definition">¶</a></dt> |
|
418 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.common.types.BaseDataType" title="pyams_content.shared.common.types.BaseDataType"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.types.BaseDataType</span></code></a></p> |
|
419 <p>Data sub-type persistent class</p> |
|
420 </dd></dl> |
|
421 |
|
422 <dl class="class"> |
|
423 <dt id="pyams_content.shared.common.types.TypedDataManager"> |
|
424 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedDataManager</code><a class="headerlink" href="#pyams_content.shared.common.types.TypedDataManager" title="Permalink to this definition">¶</a></dt> |
|
425 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.ordered.OrderedContainer</span></code></p> |
|
426 <p>Data types container persistent class</p> |
|
427 </dd></dl> |
|
428 |
|
429 <dl class="class"> |
|
430 <dt id="pyams_content.shared.common.types.TypedSharedTool"> |
|
431 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedSharedTool</code><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedTool" title="Permalink to this definition">¶</a></dt> |
|
432 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.common.manager.SharedTool" title="pyams_content.shared.common.manager.SharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.SharedTool</span></code></a></p> |
|
433 <p>Typed shared tool</p> |
|
434 <dl class="attribute"> |
|
435 <dt id="pyams_content.shared.common.types.TypedSharedTool.shared_content_types_fields"> |
|
436 <code class="descname">shared_content_types_fields</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedTool.shared_content_types_fields" title="Permalink to this definition">¶</a></dt> |
|
437 <dd></dd></dl> |
|
438 |
|
439 </dd></dl> |
|
440 |
|
441 <dl class="function"> |
|
442 <dt id="pyams_content.shared.common.types.TypedSharedToolDataManagerFactory"> |
|
443 <code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedSharedToolDataManagerFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedToolDataManagerFactory" title="Permalink to this definition">¶</a></dt> |
|
444 <dd><p>Types shared tool data manager factory</p> |
|
445 </dd></dl> |
|
446 |
|
447 <dl class="class"> |
|
448 <dt id="pyams_content.shared.common.types.TypedSharedToolDataTypesFields"> |
|
449 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedSharedToolDataTypesFields</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedToolDataTypesFields" title="Permalink to this definition">¶</a></dt> |
|
450 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
451 <p>Typed shared tool data types fields vocabulary</p> |
|
452 </dd></dl> |
|
453 |
|
454 <dl class="class"> |
|
455 <dt id="pyams_content.shared.common.types.TypedSharedToolSublocations"> |
|
456 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedSharedToolSublocations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedToolSublocations" title="Permalink to this definition">¶</a></dt> |
|
457 <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> |
|
458 <p>Typed shared tool sublocations adapter</p> |
|
459 <dl class="method"> |
|
460 <dt id="pyams_content.shared.common.types.TypedSharedToolSublocations.sublocations"> |
|
461 <code class="descname">sublocations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedToolSublocations.sublocations" title="Permalink to this definition">¶</a></dt> |
|
462 <dd></dd></dl> |
|
463 |
|
464 </dd></dl> |
|
465 |
|
466 <dl class="class"> |
|
467 <dt id="pyams_content.shared.common.types.TypedSharedToolTypesNamespace"> |
|
468 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.types.</code><code class="descname">TypedSharedToolTypesNamespace</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.types.TypedSharedToolTypesNamespace" title="Permalink to this definition">¶</a></dt> |
|
469 <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> |
|
470 <p>Typed shared tool ++types++ namespace</p> |
|
471 <dl class="method"> |
|
472 <dt id="pyams_content.shared.common.types.TypedSharedToolTypesNamespace.traverse"> |
|
473 <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_content.shared.common.types.TypedSharedToolTypesNamespace.traverse" title="Permalink to this definition">¶</a></dt> |
|
474 <dd></dd></dl> |
|
475 |
|
476 </dd></dl> |
|
477 |
|
478 </div> |
|
479 <div class="section" id="module-pyams_content.shared.common"> |
|
480 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.shared.common" title="Permalink to this headline">¶</a></h2> |
|
481 <dl class="class"> |
|
482 <dt id="pyams_content.shared.common.ContentTypesVocabulary"> |
|
483 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">ContentTypesVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.ContentTypesVocabulary" title="Permalink to this definition">¶</a></dt> |
|
484 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
485 <p>Content types vocabulary</p> |
|
486 </dd></dl> |
|
487 |
|
488 <dl class="class"> |
|
489 <dt id="pyams_content.shared.common.SharedContent"> |
|
490 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">SharedContent</code><a class="headerlink" href="#pyams_content.shared.common.SharedContent" title="Permalink to this definition">¶</a></dt> |
|
491 <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> |
|
492 <p>Workflow managed shared data</p> |
|
493 <dl class="attribute"> |
|
494 <dt id="pyams_content.shared.common.SharedContent.sequence_name"> |
|
495 <code class="descname">sequence_name</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.common.SharedContent.sequence_name" title="Permalink to this definition">¶</a></dt> |
|
496 <dd></dd></dl> |
|
497 |
|
498 <dl class="attribute"> |
|
499 <dt id="pyams_content.shared.common.SharedContent.sequence_prefix"> |
|
500 <code class="descname">sequence_prefix</code><em class="property"> = ''</em><a class="headerlink" href="#pyams_content.shared.common.SharedContent.sequence_prefix" title="Permalink to this definition">¶</a></dt> |
|
501 <dd></dd></dl> |
|
502 |
|
503 <dl class="attribute"> |
|
504 <dt id="pyams_content.shared.common.SharedContent.view_permission"> |
|
505 <code class="descname">view_permission</code><em class="property"> = 'view'</em><a class="headerlink" href="#pyams_content.shared.common.SharedContent.view_permission" title="Permalink to this definition">¶</a></dt> |
|
506 <dd></dd></dl> |
|
507 |
|
508 <dl class="attribute"> |
|
509 <dt id="pyams_content.shared.common.SharedContent.workflow_name"> |
|
510 <code class="descname">workflow_name</code><a class="headerlink" href="#pyams_content.shared.common.SharedContent.workflow_name" title="Permalink to this definition">¶</a></dt> |
|
511 <dd></dd></dl> |
|
512 |
|
513 </dd></dl> |
|
514 |
|
515 <dl class="class"> |
|
516 <dt id="pyams_content.shared.common.SharedContentInfoAdapter"> |
|
517 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">SharedContentInfoAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.SharedContentInfoAdapter" title="Permalink to this definition">¶</a></dt> |
|
518 <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> |
|
519 <p>Shared content base info adapter</p> |
|
520 <dl class="attribute"> |
|
521 <dt id="pyams_content.shared.common.SharedContentInfoAdapter.created_date"> |
|
522 <code class="descname">created_date</code><a class="headerlink" href="#pyams_content.shared.common.SharedContentInfoAdapter.created_date" title="Permalink to this definition">¶</a></dt> |
|
523 <dd></dd></dl> |
|
524 |
|
525 <dl class="attribute"> |
|
526 <dt id="pyams_content.shared.common.SharedContentInfoAdapter.modified_date"> |
|
527 <code class="descname">modified_date</code><a class="headerlink" href="#pyams_content.shared.common.SharedContentInfoAdapter.modified_date" title="Permalink to this definition">¶</a></dt> |
|
528 <dd></dd></dl> |
|
529 |
|
530 </dd></dl> |
|
531 |
|
532 <dl class="function"> |
|
533 <dt id="pyams_content.shared.common.SharedContentWorkflowAdapter"> |
|
534 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">SharedContentWorkflowAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.SharedContentWorkflowAdapter" title="Permalink to this definition">¶</a></dt> |
|
535 <dd><p>Shared content workflow adapter</p> |
|
536 </dd></dl> |
|
537 |
|
538 <dl class="class"> |
|
539 <dt id="pyams_content.shared.common.SharedSiteVocabulary"> |
|
540 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">SharedSiteVocabulary</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.SharedSiteVocabulary" title="Permalink to this definition">¶</a></dt> |
|
541 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
542 <p>Shared sites vocabulary</p> |
|
543 <dl class="attribute"> |
|
544 <dt id="pyams_content.shared.common.SharedSiteVocabulary.interface"> |
|
545 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_content.shared.common.interfaces.ISharedSite></em><a class="headerlink" href="#pyams_content.shared.common.SharedSiteVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
546 <dd></dd></dl> |
|
547 |
|
548 </dd></dl> |
|
549 |
|
550 <dl class="class"> |
|
551 <dt id="pyams_content.shared.common.WfSharedContent"> |
|
552 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">WfSharedContent</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent" title="Permalink to this definition">¶</a></dt> |
|
553 <dd><p>Bases: <a class="reference internal" href="pyams_security.html#pyams_security.security.ProtectedObject" title="pyams_security.security.ProtectedObject"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.security.ProtectedObject</span></code></a>, <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>, <a class="reference internal" href="pyams_i18n.html#pyams_i18n.content.I18nManagerMixin" title="pyams_i18n.content.I18nManagerMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_i18n.content.I18nManagerMixin</span></code></a></p> |
|
554 <p>Shared data content class</p> |
|
555 <dl class="attribute"> |
|
556 <dt id="pyams_content.shared.common.WfSharedContent.content_type"> |
|
557 <code class="descname">content_type</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.content_type" title="Permalink to this definition">¶</a></dt> |
|
558 <dd></dd></dl> |
|
559 |
|
560 <dl class="attribute"> |
|
561 <dt id="pyams_content.shared.common.WfSharedContent.contributors"> |
|
562 <code class="descname">contributors</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.contributors" title="Permalink to this definition">¶</a></dt> |
|
563 <dd><p>Custom field property used to handle role principals</p> |
|
564 </dd></dl> |
|
565 |
|
566 <dl class="attribute"> |
|
567 <dt id="pyams_content.shared.common.WfSharedContent.creation_label"> |
|
568 <code class="descname">creation_label</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.creation_label" title="Permalink to this definition">¶</a></dt> |
|
569 <dd></dd></dl> |
|
570 |
|
571 <dl class="attribute"> |
|
572 <dt id="pyams_content.shared.common.WfSharedContent.creator"> |
|
573 <code class="descname">creator</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.creator" title="Permalink to this definition">¶</a></dt> |
|
574 <dd><p>Computed attributes based on schema fields</p> |
|
575 <p>Field properties provide default values, data validation and error messages |
|
576 based on data found in field meta-data.</p> |
|
577 <p>Note that FieldProperties cannot be used with slots. They can only |
|
578 be used for attributes stored in instance dictionaries.</p> |
|
579 </dd></dl> |
|
580 |
|
581 <dl class="attribute"> |
|
582 <dt id="pyams_content.shared.common.WfSharedContent.description"> |
|
583 <code class="descname">description</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.description" title="Permalink to this definition">¶</a></dt> |
|
584 <dd><p>Computed attributes based on schema fields</p> |
|
585 <p>Field properties provide default values, data validation and error messages |
|
586 based on data found in field meta-data.</p> |
|
587 <p>Note that FieldProperties cannot be used with slots. They can only |
|
588 be used for attributes stored in instance dictionaries.</p> |
|
589 </dd></dl> |
|
590 |
|
591 <dl class="attribute"> |
|
592 <dt id="pyams_content.shared.common.WfSharedContent.first_owner"> |
|
593 <code class="descname">first_owner</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.first_owner" title="Permalink to this definition">¶</a></dt> |
|
594 <dd></dd></dl> |
|
595 |
|
596 <dl class="attribute"> |
|
597 <dt id="pyams_content.shared.common.WfSharedContent.guests"> |
|
598 <code class="descname">guests</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.guests" title="Permalink to this definition">¶</a></dt> |
|
599 <dd><p>Custom field property used to handle role principals</p> |
|
600 </dd></dl> |
|
601 |
|
602 <dl class="attribute"> |
|
603 <dt id="pyams_content.shared.common.WfSharedContent.keywords"> |
|
604 <code class="descname">keywords</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.keywords" title="Permalink to this definition">¶</a></dt> |
|
605 <dd><p>Computed attributes based on schema fields</p> |
|
606 <p>Field properties provide default values, data validation and error messages |
|
607 based on data found in field meta-data.</p> |
|
608 <p>Note that FieldProperties cannot be used with slots. They can only |
|
609 be used for attributes stored in instance dictionaries.</p> |
|
610 </dd></dl> |
|
611 |
|
612 <dl class="attribute"> |
|
613 <dt id="pyams_content.shared.common.WfSharedContent.last_modifier"> |
|
614 <code class="descname">last_modifier</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.last_modifier" title="Permalink to this definition">¶</a></dt> |
|
615 <dd><p>Computed attributes based on schema fields</p> |
|
616 <p>Field properties provide default values, data validation and error messages |
|
617 based on data found in field meta-data.</p> |
|
618 <p>Note that FieldProperties cannot be used with slots. They can only |
|
619 be used for attributes stored in instance dictionaries.</p> |
|
620 </dd></dl> |
|
621 |
|
622 <dl class="attribute"> |
|
623 <dt id="pyams_content.shared.common.WfSharedContent.last_update_label"> |
|
624 <code class="descname">last_update_label</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.last_update_label" title="Permalink to this definition">¶</a></dt> |
|
625 <dd></dd></dl> |
|
626 |
|
627 <dl class="attribute"> |
|
628 <dt id="pyams_content.shared.common.WfSharedContent.managers"> |
|
629 <code class="descname">managers</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.managers" title="Permalink to this definition">¶</a></dt> |
|
630 <dd><p>Custom field property used to handle role principals</p> |
|
631 </dd></dl> |
|
632 |
|
633 <dl class="attribute"> |
|
634 <dt id="pyams_content.shared.common.WfSharedContent.modifiers"> |
|
635 <code class="descname">modifiers</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.modifiers" title="Permalink to this definition">¶</a></dt> |
|
636 <dd><p>Computed attributes based on schema fields</p> |
|
637 <p>Field properties provide default values, data validation and error messages |
|
638 based on data found in field meta-data.</p> |
|
639 <p>Note that FieldProperties cannot be used with slots. They can only |
|
640 be used for attributes stored in instance dictionaries.</p> |
|
641 </dd></dl> |
|
642 |
|
643 <dl class="attribute"> |
|
644 <dt id="pyams_content.shared.common.WfSharedContent.notepad"> |
|
645 <code class="descname">notepad</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.notepad" title="Permalink to this definition">¶</a></dt> |
|
646 <dd><p>Computed attributes based on schema fields</p> |
|
647 <p>Field properties provide default values, data validation and error messages |
|
648 based on data found in field meta-data.</p> |
|
649 <p>Note that FieldProperties cannot be used with slots. They can only |
|
650 be used for attributes stored in instance dictionaries.</p> |
|
651 </dd></dl> |
|
652 |
|
653 <dl class="attribute"> |
|
654 <dt id="pyams_content.shared.common.WfSharedContent.owner"> |
|
655 <code class="descname">owner</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.owner" title="Permalink to this definition">¶</a></dt> |
|
656 <dd><p>Custom field property used to handle role principals</p> |
|
657 </dd></dl> |
|
658 |
|
659 <dl class="attribute"> |
|
660 <dt id="pyams_content.shared.common.WfSharedContent.readers"> |
|
661 <code class="descname">readers</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.readers" title="Permalink to this definition">¶</a></dt> |
|
662 <dd><p>Custom field property used to handle role principals</p> |
|
663 </dd></dl> |
|
664 |
|
665 <dl class="attribute"> |
|
666 <dt id="pyams_content.shared.common.WfSharedContent.roles_interface"> |
|
667 <code class="descname">roles_interface</code><em class="property"> = <InterfaceClass pyams_content.shared.common.interfaces.IWfSharedContentRoles></em><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.roles_interface" title="Permalink to this definition">¶</a></dt> |
|
668 <dd></dd></dl> |
|
669 |
|
670 <dl class="attribute"> |
|
671 <dt id="pyams_content.shared.common.WfSharedContent.short_name"> |
|
672 <code class="descname">short_name</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.short_name" title="Permalink to this definition">¶</a></dt> |
|
673 <dd><p>Computed attributes based on schema fields</p> |
|
674 <p>Field properties provide default values, data validation and error messages |
|
675 based on data found in field meta-data.</p> |
|
676 <p>Note that FieldProperties cannot be used with slots. They can only |
|
677 be used for attributes stored in instance dictionaries.</p> |
|
678 </dd></dl> |
|
679 |
|
680 <dl class="attribute"> |
|
681 <dt id="pyams_content.shared.common.WfSharedContent.title"> |
|
682 <code class="descname">title</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContent.title" title="Permalink to this definition">¶</a></dt> |
|
683 <dd><p>Computed attributes based on schema fields</p> |
|
684 <p>Field properties provide default values, data validation and error messages |
|
685 based on data found in field meta-data.</p> |
|
686 <p>Note that FieldProperties cannot be used with slots. They can only |
|
687 be used for attributes stored in instance dictionaries.</p> |
|
688 </dd></dl> |
|
689 |
|
690 </dd></dl> |
|
691 |
|
692 <dl class="class"> |
|
693 <dt id="pyams_content.shared.common.WfSharedContentChecker"> |
|
694 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">WfSharedContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentChecker" title="Permalink to this definition">¶</a></dt> |
|
695 <dd><p>Bases: <a class="reference internal" href="pyams_content.features.checker.html#pyams_content.features.checker.BaseContentChecker" title="pyams_content.features.checker.BaseContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.features.checker.BaseContentChecker</span></code></a></p> |
|
696 <p>Default shared content checker</p> |
|
697 <dl class="method"> |
|
698 <dt id="pyams_content.shared.common.WfSharedContentChecker.inner_check"> |
|
699 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
700 <dd></dd></dl> |
|
701 |
|
702 <dl class="attribute"> |
|
703 <dt id="pyams_content.shared.common.WfSharedContentChecker.label"> |
|
704 <code class="descname">label</code><em class="property"> = 'Properties'</em><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentChecker.label" title="Permalink to this definition">¶</a></dt> |
|
705 <dd></dd></dl> |
|
706 |
|
707 </dd></dl> |
|
708 |
|
709 <dl class="class"> |
|
710 <dt id="pyams_content.shared.common.WfSharedContentInfoAdapter"> |
|
711 <em class="property">class </em><code class="descclassname">pyams_content.shared.common.</code><code class="descname">WfSharedContentInfoAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentInfoAdapter" title="Permalink to this definition">¶</a></dt> |
|
712 <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> |
|
713 <p>Shared content base info adapter</p> |
|
714 <dl class="attribute"> |
|
715 <dt id="pyams_content.shared.common.WfSharedContentInfoAdapter.created_date"> |
|
716 <code class="descname">created_date</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentInfoAdapter.created_date" title="Permalink to this definition">¶</a></dt> |
|
717 <dd></dd></dl> |
|
718 |
|
719 <dl class="attribute"> |
|
720 <dt id="pyams_content.shared.common.WfSharedContentInfoAdapter.modified_date"> |
|
721 <code class="descname">modified_date</code><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentInfoAdapter.modified_date" title="Permalink to this definition">¶</a></dt> |
|
722 <dd></dd></dl> |
|
723 |
|
724 </dd></dl> |
|
725 |
|
726 <dl class="function"> |
|
727 <dt id="pyams_content.shared.common.WfSharedContentSequenceAdapter"> |
|
728 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">WfSharedContentSequenceAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentSequenceAdapter" title="Permalink to this definition">¶</a></dt> |
|
729 <dd><p>Shared content sequence adapter</p> |
|
730 </dd></dl> |
|
731 |
|
732 <dl class="function"> |
|
733 <dt id="pyams_content.shared.common.WfSharedContentWorkflowAdapter"> |
|
734 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">WfSharedContentWorkflowAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.WfSharedContentWorkflowAdapter" title="Permalink to this definition">¶</a></dt> |
|
735 <dd><p>Shared content workflow adapter</p> |
|
736 </dd></dl> |
|
737 |
|
738 <dl class="function"> |
|
739 <dt id="pyams_content.shared.common.handle_cloned_shared_content"> |
|
740 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">handle_cloned_shared_content</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.handle_cloned_shared_content" title="Permalink to this definition">¶</a></dt> |
|
741 <dd><p>Handle cloned object when a new version is created</p> |
|
742 <p>Current principal is set as version creator, and is added to version |
|
743 contributors if he is not the original content’s owner</p> |
|
744 </dd></dl> |
|
745 |
|
746 <dl class="function"> |
|
747 <dt id="pyams_content.shared.common.handle_content_types"> |
|
748 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">handle_content_types</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.handle_content_types" title="Permalink to this definition">¶</a></dt> |
|
749 <dd><p>Check for content types to un-register</p> |
|
750 </dd></dl> |
|
751 |
|
752 <dl class="function"> |
|
753 <dt id="pyams_content.shared.common.handle_modified_shared_content"> |
|
754 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">handle_modified_shared_content</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.handle_modified_shared_content" title="Permalink to this definition">¶</a></dt> |
|
755 <dd><p>Define content’s modifiers when content is modified</p> |
|
756 </dd></dl> |
|
757 |
|
758 <dl class="function"> |
|
759 <dt id="pyams_content.shared.common.register_content_type"> |
|
760 <code class="descclassname">pyams_content.shared.common.</code><code class="descname">register_content_type</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.common.register_content_type" title="Permalink to this definition">¶</a></dt> |
|
761 <dd><p>Register a new content type</p> |
|
762 </dd></dl> |
|
763 |
|
764 </div> |
|
765 </div> |
|
766 |
|
767 |
|
768 </div> |
|
769 </div> |
|
770 </div> |
|
771 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
772 <div class="sphinxsidebarwrapper"> |
|
773 <h3><a href="index.html">Table Of Contents</a></h3> |
|
774 <ul> |
|
775 <li><a class="reference internal" href="#">pyams_content.shared.common package</a><ul> |
|
776 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
777 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
778 <li><a class="reference internal" href="#module-pyams_content.shared.common.manager">pyams_content.shared.common.manager module</a></li> |
|
779 <li><a class="reference internal" href="#module-pyams_content.shared.common.review">pyams_content.shared.common.review module</a></li> |
|
780 <li><a class="reference internal" href="#module-pyams_content.shared.common.security">pyams_content.shared.common.security module</a></li> |
|
781 <li><a class="reference internal" href="#module-pyams_content.shared.common.types">pyams_content.shared.common.types module</a></li> |
|
782 <li><a class="reference internal" href="#module-pyams_content.shared.common">Module contents</a></li> |
|
783 </ul> |
|
784 </li> |
|
785 </ul> |
|
786 |
|
787 <div id="searchbox" style="display: none" role="search"> |
|
788 <h3>Quick search</h3> |
|
789 <form class="search" action="search.html" method="get"> |
|
790 <div><input type="text" name="q" /></div> |
|
791 <div><input type="submit" value="Go" /></div> |
|
792 <input type="hidden" name="check_keywords" value="yes" /> |
|
793 <input type="hidden" name="area" value="default" /> |
|
794 </form> |
|
795 </div> |
|
796 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
797 </div> |
|
798 </div> |
|
799 <div class="clearer"></div> |
|
800 </div> |
|
801 <div class="related" role="navigation" aria-label="related navigation"> |
|
802 <h3>Navigation</h3> |
|
803 <ul> |
|
804 <li class="right" style="margin-right: 10px"> |
|
805 <a href="genindex.html" title="General Index" |
|
806 >index</a></li> |
|
807 <li class="right" > |
|
808 <a href="py-modindex.html" title="Python Module Index" |
|
809 >modules</a> |</li> |
|
810 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
811 </ul> |
|
812 </div> |
|
813 <div class="footer" role="contentinfo"> |
|
814 © Copyright 2017, Thierry Florac. |
|
815 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
816 </div> |
|
817 </body> |
|
818 </html> |