|
1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>ccm.Folder</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 <a href="ccm-module.html">Package ccm</a> :: |
|
38 Class Folder |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="ccm.Folder-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class Folder</h1><span class="codelink"><a href="ccm-pysrc.html#Folder">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="ccm.FourPartName-class.html">FourPartName</a> --+ |
|
60 | |
|
61 <a href="ccm.CCMObject-class.html">CCMObject</a> --+ |
|
62 | |
|
63 <strong class="uidshort">Folder</strong> |
|
64 </pre> |
|
65 |
|
66 <hr /> |
|
67 Wrapper class for Synergy folder object<br /><br /> |
|
68 |
|
69 <!-- ==================== INSTANCE METHODS ==================== --> |
|
70 <a name="section-InstanceMethods"></a> |
|
71 <table class="summary" border="1" cellpadding="3" |
|
72 cellspacing="0" width="100%" bgcolor="white"> |
|
73 <tr bgcolor="#70b0f0" class="table-header"> |
|
74 <td colspan="2" class="table-header"> |
|
75 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
76 <tr valign="top"> |
|
77 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
78 <td align="right" valign="top" |
|
79 ><span class="options">[<a href="#section-InstanceMethods" |
|
80 class="privatelink" onclick="toggle_private();" |
|
81 >hide private</a>]</span></td> |
|
82 </tr> |
|
83 </table> |
|
84 </td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td width="15%" align="right" valign="top" class="summary"> |
|
88 <span class="summary-type"> </span> |
|
89 </td><td class="summary"> |
|
90 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
91 <tr> |
|
92 <td><span class="summary-sig"><a href="ccm.Folder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
93 <span class="summary-sig-arg">session</span>, |
|
94 <span class="summary-sig-arg">fpn</span>)</span><br /> |
|
95 Create a FourPartName object based on a ifpn string.</td> |
|
96 <td align="right" valign="top"> |
|
97 <span class="codelink"><a href="ccm-pysrc.html#Folder.__init__">source code</a></span> |
|
98 |
|
99 </td> |
|
100 </tr> |
|
101 </table> |
|
102 |
|
103 </td> |
|
104 </tr> |
|
105 <tr class="private"> |
|
106 <td width="15%" align="right" valign="top" class="summary"> |
|
107 <span class="summary-type"> </span> |
|
108 </td><td class="summary"> |
|
109 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
110 <tr> |
|
111 <td><span class="summary-sig"><a name="_gettasks"></a><span class="summary-sig-name">_gettasks</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
112 Accessor for 'tasks' property.</td> |
|
113 <td align="right" valign="top"> |
|
114 <span class="codelink"><a href="ccm-pysrc.html#Folder._gettasks">source code</a></span> |
|
115 |
|
116 </td> |
|
117 </tr> |
|
118 </table> |
|
119 |
|
120 </td> |
|
121 </tr> |
|
122 <tr class="private"> |
|
123 <td width="15%" align="right" valign="top" class="summary"> |
|
124 <span class="summary-type"> </span> |
|
125 </td><td class="summary"> |
|
126 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
127 <tr> |
|
128 <td><span class="summary-sig"><a name="_getobjects"></a><span class="summary-sig-name">_getobjects</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
129 <td align="right" valign="top"> |
|
130 <span class="codelink"><a href="ccm-pysrc.html#Folder._getobjects">source code</a></span> |
|
131 |
|
132 </td> |
|
133 </tr> |
|
134 </table> |
|
135 |
|
136 </td> |
|
137 </tr> |
|
138 <tr class="private"> |
|
139 <td width="15%" align="right" valign="top" class="summary"> |
|
140 <span class="summary-type"> </span> |
|
141 </td><td class="summary"> |
|
142 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
143 <tr> |
|
144 <td><span class="summary-sig"><a name="_getmode"></a><span class="summary-sig-name">_getmode</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
145 Get the mode used by the folder.</td> |
|
146 <td align="right" valign="top"> |
|
147 <span class="codelink"><a href="ccm-pysrc.html#Folder._getmode">source code</a></span> |
|
148 |
|
149 </td> |
|
150 </tr> |
|
151 </table> |
|
152 |
|
153 </td> |
|
154 </tr> |
|
155 <tr class="private"> |
|
156 <td width="15%" align="right" valign="top" class="summary"> |
|
157 <span class="summary-type"> </span> |
|
158 </td><td class="summary"> |
|
159 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
160 <tr> |
|
161 <td><span class="summary-sig"><a name="_getquery"></a><span class="summary-sig-name">_getquery</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
162 Get the query that populate the folder.</td> |
|
163 <td align="right" valign="top"> |
|
164 <span class="codelink"><a href="ccm-pysrc.html#Folder._getquery">source code</a></span> |
|
165 |
|
166 </td> |
|
167 </tr> |
|
168 </table> |
|
169 |
|
170 </td> |
|
171 </tr> |
|
172 <tr class="private"> |
|
173 <td width="15%" align="right" valign="top" class="summary"> |
|
174 <span class="summary-type"> </span> |
|
175 </td><td class="summary"> |
|
176 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
177 <tr> |
|
178 <td><span class="summary-sig"><a name="_getdescription"></a><span class="summary-sig-name">_getdescription</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
179 Get the description associated with the folder.</td> |
|
180 <td align="right" valign="top"> |
|
181 <span class="codelink"><a href="ccm-pysrc.html#Folder._getdescription">source code</a></span> |
|
182 |
|
183 </td> |
|
184 </tr> |
|
185 </table> |
|
186 |
|
187 </td> |
|
188 </tr> |
|
189 <tr> |
|
190 <td width="15%" align="right" valign="top" class="summary"> |
|
191 <span class="summary-type"> </span> |
|
192 </td><td class="summary"> |
|
193 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
194 <tr> |
|
195 <td><span class="summary-sig"><a name="remove"></a><span class="summary-sig-name">remove</span>(<span class="summary-sig-arg">self</span>, |
|
196 <span class="summary-sig-arg">task</span>)</span><br /> |
|
197 Remove task from this folder.</td> |
|
198 <td align="right" valign="top"> |
|
199 <span class="codelink"><a href="ccm-pysrc.html#Folder.remove">source code</a></span> |
|
200 |
|
201 </td> |
|
202 </tr> |
|
203 </table> |
|
204 |
|
205 </td> |
|
206 </tr> |
|
207 <tr> |
|
208 <td width="15%" align="right" valign="top" class="summary"> |
|
209 <span class="summary-type"> </span> |
|
210 </td><td class="summary"> |
|
211 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
212 <tr> |
|
213 <td><span class="summary-sig"><a name="update"></a><span class="summary-sig-name">update</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
214 <td align="right" valign="top"> |
|
215 <span class="codelink"><a href="ccm-pysrc.html#Folder.update">source code</a></span> |
|
216 |
|
217 </td> |
|
218 </tr> |
|
219 </table> |
|
220 |
|
221 </td> |
|
222 </tr> |
|
223 <tr> |
|
224 <td width="15%" align="right" valign="top" class="summary"> |
|
225 <span class="summary-type"> </span> |
|
226 </td><td class="summary"> |
|
227 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
228 <tr> |
|
229 <td><span class="summary-sig"><a name="append"></a><span class="summary-sig-name">append</span>(<span class="summary-sig-arg">self</span>, |
|
230 <span class="summary-sig-arg">task</span>)</span><br /> |
|
231 Associate an object to a task</td> |
|
232 <td align="right" valign="top"> |
|
233 <span class="codelink"><a href="ccm-pysrc.html#Folder.append">source code</a></span> |
|
234 |
|
235 </td> |
|
236 </tr> |
|
237 </table> |
|
238 |
|
239 </td> |
|
240 </tr> |
|
241 <tr> |
|
242 <td width="15%" align="right" valign="top" class="summary"> |
|
243 <span class="summary-type"> </span> |
|
244 </td><td class="summary"> |
|
245 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
246 <tr> |
|
247 <td><span class="summary-sig"><a href="ccm.Folder-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>, |
|
248 <span class="summary-sig-arg">existing_folder</span>)</span><br /> |
|
249 Copy the contents of existing_folder into this folder.</td> |
|
250 <td align="right" valign="top"> |
|
251 <span class="codelink"><a href="ccm-pysrc.html#Folder.copy">source code</a></span> |
|
252 |
|
253 </td> |
|
254 </tr> |
|
255 </table> |
|
256 |
|
257 </td> |
|
258 </tr> |
|
259 <tr> |
|
260 <td width="15%" align="right" valign="top" class="summary"> |
|
261 <span class="summary-type"> </span> |
|
262 </td><td class="summary"> |
|
263 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
264 <tr> |
|
265 <td><span class="summary-sig"><a name="objects"></a><span class="summary-sig-name">objects</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
266 <td align="right" valign="top"> |
|
267 <span class="codelink"><a href="ccm-pysrc.html#Folder.objects">source code</a></span> |
|
268 |
|
269 </td> |
|
270 </tr> |
|
271 </table> |
|
272 |
|
273 </td> |
|
274 </tr> |
|
275 <tr> |
|
276 <td width="15%" align="right" valign="top" class="summary"> |
|
277 <span class="summary-type"> </span> |
|
278 </td><td class="summary"> |
|
279 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
280 <tr> |
|
281 <td><span class="summary-sig"><a name="tasks"></a><span class="summary-sig-name">tasks</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
282 Accessor for 'tasks' property.</td> |
|
283 <td align="right" valign="top"> |
|
284 <span class="codelink"><a href="ccm-pysrc.html#Folder.tasks">source code</a></span> |
|
285 |
|
286 </td> |
|
287 </tr> |
|
288 </table> |
|
289 |
|
290 </td> |
|
291 </tr> |
|
292 <tr> |
|
293 <td width="15%" align="right" valign="top" class="summary"> |
|
294 <span class="summary-type"> </span> |
|
295 </td><td class="summary"> |
|
296 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
297 <tr> |
|
298 <td><span class="summary-sig"><a name="mode"></a><span class="summary-sig-name">mode</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
299 Get the mode used by the folder.</td> |
|
300 <td align="right" valign="top"> |
|
301 <span class="codelink"><a href="ccm-pysrc.html#Folder.mode">source code</a></span> |
|
302 |
|
303 </td> |
|
304 </tr> |
|
305 </table> |
|
306 |
|
307 </td> |
|
308 </tr> |
|
309 <tr> |
|
310 <td width="15%" align="right" valign="top" class="summary"> |
|
311 <span class="summary-type"> </span> |
|
312 </td><td class="summary"> |
|
313 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
314 <tr> |
|
315 <td><span class="summary-sig"><a name="query"></a><span class="summary-sig-name">query</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
316 Get the query that populate the folder.</td> |
|
317 <td align="right" valign="top"> |
|
318 <span class="codelink"><a href="ccm-pysrc.html#Folder.query">source code</a></span> |
|
319 |
|
320 </td> |
|
321 </tr> |
|
322 </table> |
|
323 |
|
324 </td> |
|
325 </tr> |
|
326 <tr> |
|
327 <td width="15%" align="right" valign="top" class="summary"> |
|
328 <span class="summary-type"> </span> |
|
329 </td><td class="summary"> |
|
330 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
331 <tr> |
|
332 <td><span class="summary-sig"><a name="description"></a><span class="summary-sig-name">description</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
333 Get the description associated with the folder.</td> |
|
334 <td align="right" valign="top"> |
|
335 <span class="codelink"><a href="ccm-pysrc.html#Folder.description">source code</a></span> |
|
336 |
|
337 </td> |
|
338 </tr> |
|
339 </table> |
|
340 |
|
341 </td> |
|
342 </tr> |
|
343 <tr> |
|
344 <td colspan="2" class="summary"> |
|
345 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b>: |
|
346 <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>, |
|
347 <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>, |
|
348 <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>, |
|
349 <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>, |
|
350 <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>, |
|
351 <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>, |
|
352 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>, |
|
353 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>, |
|
354 <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>, |
|
355 <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>, |
|
356 <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>, |
|
357 <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>, |
|
358 <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>, |
|
359 <code><a href="ccm.CCMObject-class.html#session">session</a></code>, |
|
360 <code><a href="ccm.CCMObject-class.html#successors">successors</a></code> |
|
361 </p> |
|
362 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b> (private): |
|
363 <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code> |
|
364 </p></div> |
|
365 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: |
|
366 <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>, |
|
367 <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>, |
|
368 <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>, |
|
369 <code><a href="ccm.FourPartName-class.html#__str__">__str__</a></code>, |
|
370 <code><a href="ccm.FourPartName-class.html#family">family</a></code>, |
|
371 <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>, |
|
372 <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>, |
|
373 <code><a href="ccm.FourPartName-class.html#name">name</a></code>, |
|
374 <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>, |
|
375 <code><a href="ccm.FourPartName-class.html#type">type</a></code>, |
|
376 <code><a href="ccm.FourPartName-class.html#version">version</a></code> |
|
377 </p> |
|
378 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
379 <code>__delattr__</code>, |
|
380 <code>__getattribute__</code>, |
|
381 <code>__hash__</code>, |
|
382 <code>__new__</code>, |
|
383 <code>__reduce__</code>, |
|
384 <code>__reduce_ex__</code>, |
|
385 <code>__setattr__</code> |
|
386 </p> |
|
387 </td> |
|
388 </tr> |
|
389 </table> |
|
390 <!-- ==================== STATIC METHODS ==================== --> |
|
391 <a name="section-StaticMethods"></a> |
|
392 <table class="summary" border="1" cellpadding="3" |
|
393 cellspacing="0" width="100%" bgcolor="white"> |
|
394 <tr bgcolor="#70b0f0" class="table-header"> |
|
395 <td colspan="2" class="table-header"> |
|
396 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
397 <tr valign="top"> |
|
398 <td align="left"><span class="table-header">Static Methods</span></td> |
|
399 <td align="right" valign="top" |
|
400 ><span class="options">[<a href="#section-StaticMethods" |
|
401 class="privatelink" onclick="toggle_private();" |
|
402 >hide private</a>]</span></td> |
|
403 </tr> |
|
404 </table> |
|
405 </td> |
|
406 </tr> |
|
407 <tr> |
|
408 <td colspan="2" class="summary"> |
|
409 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: |
|
410 <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>, |
|
411 <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></code> |
|
412 </p> |
|
413 </td> |
|
414 </tr> |
|
415 </table> |
|
416 <!-- ==================== CLASS VARIABLES ==================== --> |
|
417 <a name="section-ClassVariables"></a> |
|
418 <table class="summary" border="1" cellpadding="3" |
|
419 cellspacing="0" width="100%" bgcolor="white"> |
|
420 <tr bgcolor="#70b0f0" class="table-header"> |
|
421 <td colspan="2" class="table-header"> |
|
422 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
423 <tr valign="top"> |
|
424 <td align="left"><span class="table-header">Class Variables</span></td> |
|
425 <td align="right" valign="top" |
|
426 ><span class="options">[<a href="#section-ClassVariables" |
|
427 class="privatelink" onclick="toggle_private();" |
|
428 >hide private</a>]</span></td> |
|
429 </tr> |
|
430 </table> |
|
431 </td> |
|
432 </tr> |
|
433 <tr> |
|
434 <td width="15%" align="right" valign="top" class="summary"> |
|
435 <span class="summary-type"> </span> |
|
436 </td><td class="summary"> |
|
437 <a name="is_query_based"></a><span class="summary-name">is_query_based</span> = <code title="property(lambda x: x.mode.lower()== "query")">property(lambda x: x.mode.lower()== "query")</code> |
|
438 </td> |
|
439 </tr> |
|
440 </table> |
|
441 <!-- ==================== PROPERTIES ==================== --> |
|
442 <a name="section-Properties"></a> |
|
443 <table class="summary" border="1" cellpadding="3" |
|
444 cellspacing="0" width="100%" bgcolor="white"> |
|
445 <tr bgcolor="#70b0f0" class="table-header"> |
|
446 <td colspan="2" class="table-header"> |
|
447 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
448 <tr valign="top"> |
|
449 <td align="left"><span class="table-header">Properties</span></td> |
|
450 <td align="right" valign="top" |
|
451 ><span class="options">[<a href="#section-Properties" |
|
452 class="privatelink" onclick="toggle_private();" |
|
453 >hide private</a>]</span></td> |
|
454 </tr> |
|
455 </table> |
|
456 </td> |
|
457 </tr> |
|
458 <tr> |
|
459 <td colspan="2" class="summary"> |
|
460 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
461 <code>__class__</code> |
|
462 </p> |
|
463 </td> |
|
464 </tr> |
|
465 </table> |
|
466 <!-- ==================== METHOD DETAILS ==================== --> |
|
467 <a name="section-MethodDetails"></a> |
|
468 <table class="details" border="1" cellpadding="3" |
|
469 cellspacing="0" width="100%" bgcolor="white"> |
|
470 <tr bgcolor="#70b0f0" class="table-header"> |
|
471 <td colspan="2" class="table-header"> |
|
472 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
473 <tr valign="top"> |
|
474 <td align="left"><span class="table-header">Method Details</span></td> |
|
475 <td align="right" valign="top" |
|
476 ><span class="options">[<a href="#section-MethodDetails" |
|
477 class="privatelink" onclick="toggle_private();" |
|
478 >hide private</a>]</span></td> |
|
479 </tr> |
|
480 </table> |
|
481 </td> |
|
482 </tr> |
|
483 </table> |
|
484 <a name="__init__"></a> |
|
485 <div> |
|
486 <table class="details" border="1" cellpadding="3" |
|
487 cellspacing="0" width="100%" bgcolor="white"> |
|
488 <tr><td> |
|
489 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
490 <tr valign="top"><td> |
|
491 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
492 <span class="sig-arg">session</span>, |
|
493 <span class="sig-arg">fpn</span>)</span> |
|
494 <br /><em class="fname">(Constructor)</em> |
|
495 </h3> |
|
496 </td><td align="right" valign="top" |
|
497 ><span class="codelink"><a href="ccm-pysrc.html#Folder.__init__">source code</a></span> |
|
498 </td> |
|
499 </table> |
|
500 |
|
501 <p>Create a FourPartName object based on a ifpn string.</p> |
|
502 <p>The string have to match the following patterns: |
|
503 - name-version:type:instance |
|
504 - name:version:releasedef:instance |
|
505 - Task database#id |
|
506 - Folder database#id</p> |
|
507 <p>Anything else is considered as old release string format.</p> |
|
508 <dl class="fields"> |
|
509 <dt>Overrides: |
|
510 <a href="ccm.CCMObject-class.html#__init__">CCMObject.__init__</a> |
|
511 </dt> |
|
512 </dl> |
|
513 </td></tr></table> |
|
514 </div> |
|
515 <a name="copy"></a> |
|
516 <div> |
|
517 <table class="details" border="1" cellpadding="3" |
|
518 cellspacing="0" width="100%" bgcolor="white"> |
|
519 <tr><td> |
|
520 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
521 <tr valign="top"><td> |
|
522 <h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">self</span>, |
|
523 <span class="sig-arg">existing_folder</span>)</span> |
|
524 </h3> |
|
525 </td><td align="right" valign="top" |
|
526 ><span class="codelink"><a href="ccm-pysrc.html#Folder.copy">source code</a></span> |
|
527 </td> |
|
528 </table> |
|
529 |
|
530 <p>Copy the contents of existing_folder into this folder.</p> |
|
531 <p>This appends to the destination folder by default.</p> |
|
532 <dl class="fields"> |
|
533 <dt>Parameters:</dt> |
|
534 <dd><ul class="nomargin-top"> |
|
535 <li><strong class="pname"><code>existing_folder</code></strong> - The destination Folder object.</li> |
|
536 </ul></dd> |
|
537 </dl> |
|
538 </td></tr></table> |
|
539 </div> |
|
540 <br /> |
|
541 <!-- ==================== NAVIGATION BAR ==================== --> |
|
542 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
543 bgcolor="#a0c0ff" cellspacing="0"> |
|
544 <tr valign="middle"> |
|
545 |
|
546 <!-- Tree link --> |
|
547 <th> <a |
|
548 href="module-tree.html">Trees</a> </th> |
|
549 |
|
550 <!-- Index link --> |
|
551 <th> <a |
|
552 href="identifier-index.html">Indices</a> </th> |
|
553 |
|
554 <!-- Help link --> |
|
555 <th> <a |
|
556 href="help.html">Help</a> </th> |
|
557 |
|
558 <th class="navbar" width="100%"></th> |
|
559 </tr> |
|
560 </table> |
|
561 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
562 <tr> |
|
563 <td align="left" class="footer"> |
|
564 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 |
|
565 </td> |
|
566 <td align="right" class="footer"> |
|
567 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
568 </td> |
|
569 </tr> |
|
570 </table> |
|
571 |
|
572 <script type="text/javascript"> |
|
573 <!-- |
|
574 // Private objects are initially displayed (because if |
|
575 // javascript is turned off then we want them to be |
|
576 // visible); but by default, we want to hide them. So hide |
|
577 // them unless we have a cookie that says to show them. |
|
578 checkCookie() |
|
579 // --> |
|
580 </script> |
|
581 |
|
582 </body> |
|
583 </html> |