← Back to branch summary

~nursix.org/sahana-eden/stable

« back to all changes in this revision

Viewing changes to docs/s3/vita.modules.s3.s3rest.S3Method-class.html

  • Committer: Fran Boon
  • Date: 2011-10-13 20:21:49 UTC
  • mfrom: (185.15.289 vita)
  • Revision ID: fran@aidiq.com-20111013202149-rwfv1dr7fgdfr9kr
merge nursix: cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/s3/vita.modules.s3.s3rest.S3Method-class.html
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>vita.modules.s3.s3rest.S3Method</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
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="vita.modules.s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
33
 
  <!-- Project homepage -->
34
 
      <th class="navbar" align="right" width="100%">
35
 
        <table border="0" cellpadding="0" cellspacing="0">
36
 
          <tr><th class="navbar" align="center"
37
 
            ><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
38
 
          </tr></table></th>
39
 
  </tr>
40
 
</table>
41
 
<table width="100%" cellpadding="0" cellspacing="0">
42
 
  <tr valign="top">
43
 
    <td width="100%">
44
 
      <span class="breadcrumbs">
45
 
        Package&nbsp;vita ::
46
 
        Package&nbsp;modules ::
47
 
        <a href="vita.modules.s3-module.html">Package&nbsp;s3</a> ::
48
 
        <a href="vita.modules.s3.s3rest-module.html">Module&nbsp;s3rest</a> ::
49
 
        Class&nbsp;S3Method
50
 
      </span>
51
 
    </td>
52
 
    <td>
53
 
      <table cellpadding="0" cellspacing="0">
54
 
        <!-- hide/show private -->
55
 
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56
 
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57
 
        <tr><td align="right"><span class="options"
58
 
            >[<a href="frames.html" target="_top">frames</a
59
 
            >]&nbsp;|&nbsp;<a href="vita.modules.s3.s3rest.S3Method-class.html"
60
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
61
 
      </table>
62
 
    </td>
63
 
  </tr>
64
 
</table>
65
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
66
 
<h1 class="epydoc">Class S3Method</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method">source&nbsp;code</a></span></p>
67
 
<pre class="base-tree">
68
 
object --+
69
 
         |
70
 
        <strong class="uidshort">S3Method</strong>
71
 
</pre>
72
 
 
73
 
<hr />
74
 
<p>REST Method Handler Base Class</p>
75
 
  <p>Method handler classes should inherit from this class and implement 
76
 
  the apply_method() method.</p>
77
 
 
78
 
<!-- ==================== INSTANCE METHODS ==================== -->
79
 
<a name="section-InstanceMethods"></a>
80
 
<table class="summary" border="1" cellpadding="3"
81
 
       cellspacing="0" width="100%" bgcolor="white">
82
 
<tr bgcolor="#70b0f0" class="table-header">
83
 
  <td colspan="2" class="table-header">
84
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
85
 
      <tr valign="top">
86
 
        <td align="left"><span class="table-header">Instance Methods</span></td>
87
 
        <td align="right" valign="top"
88
 
         ><span class="options">[<a href="#section-InstanceMethods"
89
 
         class="privatelink" onclick="toggle_private();"
90
 
         >hide private</a>]</span></td>
91
 
      </tr>
92
 
    </table>
93
 
  </td>
94
 
</tr>
95
 
<tr>
96
 
    <td width="15%" align="right" valign="top" class="summary">
97
 
      <span class="summary-type">&nbsp;</span>
98
 
    </td><td class="summary">
99
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
100
 
        <tr>
101
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3rest.S3Method-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
102
 
        <span class="summary-sig-arg">r</span>,
103
 
        <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">None</span>,
104
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
105
 
      Entry point for the REST interface</td>
106
 
          <td align="right" valign="top">
107
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method.__call__">source&nbsp;code</a></span>
108
 
            
109
 
          </td>
110
 
        </tr>
111
 
      </table>
112
 
      
113
 
    </td>
114
 
  </tr>
115
 
<tr>
116
 
    <td width="15%" align="right" valign="top" class="summary">
117
 
      <span class="summary-type">&nbsp;</span>
118
 
    </td><td class="summary">
119
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
120
 
        <tr>
121
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3rest.S3Method-class.html#apply_method" class="summary-sig-name">apply_method</a>(<span class="summary-sig-arg">self</span>,
122
 
        <span class="summary-sig-arg">r</span>,
123
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
124
 
      Stub for apply_method, to be implemented in subclass</td>
125
 
          <td align="right" valign="top">
126
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method.apply_method">source&nbsp;code</a></span>
127
 
            
128
 
          </td>
129
 
        </tr>
130
 
      </table>
131
 
      
132
 
    </td>
133
 
  </tr>
134
 
<tr class="private">
135
 
    <td width="15%" align="right" valign="top" class="summary">
136
 
      <span class="summary-type">&nbsp;</span>
137
 
    </td><td class="summary">
138
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
139
 
        <tr>
140
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3rest.S3Method-class.html#_config" class="summary-sig-name" onclick="show_private();">_config</a>(<span class="summary-sig-arg">self</span>,
141
 
        <span class="summary-sig-arg">key</span>,
142
 
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
143
 
      Get a configuration setting of the current table</td>
144
 
          <td align="right" valign="top">
145
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._config">source&nbsp;code</a></span>
146
 
            
147
 
          </td>
148
 
        </tr>
149
 
      </table>
150
 
      
151
 
    </td>
152
 
  </tr>
153
 
  <tr>
154
 
    <td colspan="2" class="summary">
155
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
156
 
      <code>__delattr__</code>,
157
 
      <code>__format__</code>,
158
 
      <code>__getattribute__</code>,
159
 
      <code>__hash__</code>,
160
 
      <code>__init__</code>,
161
 
      <code>__new__</code>,
162
 
      <code>__reduce__</code>,
163
 
      <code>__reduce_ex__</code>,
164
 
      <code>__repr__</code>,
165
 
      <code>__setattr__</code>,
166
 
      <code>__sizeof__</code>,
167
 
      <code>__str__</code>,
168
 
      <code>__subclasshook__</code>
169
 
      </p>
170
 
    </td>
171
 
  </tr>
172
 
</table>
173
 
<!-- ==================== STATIC METHODS ==================== -->
174
 
<a name="section-StaticMethods"></a>
175
 
<table class="summary" border="1" cellpadding="3"
176
 
       cellspacing="0" width="100%" bgcolor="white">
177
 
<tr bgcolor="#70b0f0" class="table-header">
178
 
  <td colspan="2" class="table-header">
179
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
180
 
      <tr valign="top">
181
 
        <td align="left"><span class="table-header">Static Methods</span></td>
182
 
        <td align="right" valign="top"
183
 
         ><span class="options">[<a href="#section-StaticMethods"
184
 
         class="privatelink" onclick="toggle_private();"
185
 
         >hide private</a>]</span></td>
186
 
      </tr>
187
 
    </table>
188
 
  </td>
189
 
</tr>
190
 
<tr class="private">
191
 
    <td width="15%" align="right" valign="top" class="summary">
192
 
      <span class="summary-type">&nbsp;</span>
193
 
    </td><td class="summary">
194
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
195
 
        <tr>
196
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3rest.S3Method-class.html#_record_id" class="summary-sig-name" onclick="show_private();">_record_id</a>(<span class="summary-sig-arg">r</span>)</span><br />
197
 
      Get the ID of the target record of a S3Request</td>
198
 
          <td align="right" valign="top">
199
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._record_id">source&nbsp;code</a></span>
200
 
            
201
 
          </td>
202
 
        </tr>
203
 
      </table>
204
 
      
205
 
    </td>
206
 
  </tr>
207
 
<tr class="private">
208
 
    <td width="15%" align="right" valign="top" class="summary">
209
 
      <span class="summary-type">&nbsp;</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 href="vita.modules.s3.s3rest.S3Method-class.html#_view" class="summary-sig-name" onclick="show_private();">_view</a>(<span class="summary-sig-arg">r</span>,
214
 
        <span class="summary-sig-arg">default</span>,
215
 
        <span class="summary-sig-arg">format</span>=<span class="summary-sig-default">None</span>)</span><br />
216
 
      Get the path to the view stylesheet file</td>
217
 
          <td align="right" valign="top">
218
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._view">source&nbsp;code</a></span>
219
 
            
220
 
          </td>
221
 
        </tr>
222
 
      </table>
223
 
      
224
 
    </td>
225
 
  </tr>
226
 
<tr class="private">
227
 
    <td width="15%" align="right" valign="top" class="summary">
228
 
      <span class="summary-type">&nbsp;</span>
229
 
    </td><td class="summary">
230
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
231
 
        <tr>
232
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3rest.S3Method-class.html#_extend_view" class="summary-sig-name" onclick="show_private();">_extend_view</a>(<span class="summary-sig-arg">output</span>,
233
 
        <span class="summary-sig-arg">r</span>,
234
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
235
 
      Add additional view variables (invokes all callables)</td>
236
 
          <td align="right" valign="top">
237
 
            <span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._extend_view">source&nbsp;code</a></span>
238
 
            
239
 
          </td>
240
 
        </tr>
241
 
      </table>
242
 
      
243
 
    </td>
244
 
  </tr>
245
 
</table>
246
 
<!-- ==================== PROPERTIES ==================== -->
247
 
<a name="section-Properties"></a>
248
 
<table class="summary" border="1" cellpadding="3"
249
 
       cellspacing="0" width="100%" bgcolor="white">
250
 
<tr bgcolor="#70b0f0" class="table-header">
251
 
  <td colspan="2" class="table-header">
252
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
253
 
      <tr valign="top">
254
 
        <td align="left"><span class="table-header">Properties</span></td>
255
 
        <td align="right" valign="top"
256
 
         ><span class="options">[<a href="#section-Properties"
257
 
         class="privatelink" onclick="toggle_private();"
258
 
         >hide private</a>]</span></td>
259
 
      </tr>
260
 
    </table>
261
 
  </td>
262
 
</tr>
263
 
  <tr>
264
 
    <td colspan="2" class="summary">
265
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
266
 
      <code>__class__</code>
267
 
      </p>
268
 
    </td>
269
 
  </tr>
270
 
</table>
271
 
<!-- ==================== METHOD DETAILS ==================== -->
272
 
<a name="section-MethodDetails"></a>
273
 
<table class="details" border="1" cellpadding="3"
274
 
       cellspacing="0" width="100%" bgcolor="white">
275
 
<tr bgcolor="#70b0f0" class="table-header">
276
 
  <td colspan="2" class="table-header">
277
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
278
 
      <tr valign="top">
279
 
        <td align="left"><span class="table-header">Method Details</span></td>
280
 
        <td align="right" valign="top"
281
 
         ><span class="options">[<a href="#section-MethodDetails"
282
 
         class="privatelink" onclick="toggle_private();"
283
 
         >hide private</a>]</span></td>
284
 
      </tr>
285
 
    </table>
286
 
  </td>
287
 
</tr>
288
 
</table>
289
 
<a name="__call__"></a>
290
 
<div>
291
 
<table class="details" border="1" cellpadding="3"
292
 
       cellspacing="0" width="100%" bgcolor="white">
293
 
<tr><td>
294
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
295
 
  <tr valign="top"><td>
296
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
297
 
        <span class="sig-arg">r</span>,
298
 
        <span class="sig-arg">method</span>=<span class="sig-default">None</span>,
299
 
        <span class="sig-arg">**attr</span>)</span>
300
 
    <br /><em class="fname">(Call operator)</em>
301
 
  </h3>
302
 
  </td><td align="right" valign="top"
303
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method.__call__">source&nbsp;code</a></span>&nbsp;
304
 
    </td>
305
 
  </tr></table>
306
 
  
307
 
  <p>Entry point for the REST interface</p>
308
 
  <dl class="fields">
309
 
    <dt>Parameters:</dt>
310
 
    <dd><ul class="nomargin-top">
311
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
312
 
        <li><strong class="pname"><code>method</code></strong> - the method established by the REST interface</li>
313
 
        <li><strong class="pname"><code>attr</code></strong> - dict of parameters for the method handler</li>
314
 
    </ul></dd>
315
 
    <dt>Returns:</dt>
316
 
        <dd>output object to send to the view</dd>
317
 
  </dl>
318
 
</td></tr></table>
319
 
</div>
320
 
<a name="apply_method"></a>
321
 
<div>
322
 
<table class="details" border="1" cellpadding="3"
323
 
       cellspacing="0" width="100%" bgcolor="white">
324
 
<tr><td>
325
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
326
 
  <tr valign="top"><td>
327
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">apply_method</span>(<span class="sig-arg">self</span>,
328
 
        <span class="sig-arg">r</span>,
329
 
        <span class="sig-arg">**attr</span>)</span>
330
 
  </h3>
331
 
  </td><td align="right" valign="top"
332
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method.apply_method">source&nbsp;code</a></span>&nbsp;
333
 
    </td>
334
 
  </tr></table>
335
 
  
336
 
  <p>Stub for apply_method, to be implemented in subclass</p>
337
 
  <dl class="fields">
338
 
    <dt>Parameters:</dt>
339
 
    <dd><ul class="nomargin-top">
340
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
341
 
        <li><strong class="pname"><code>attr</code></strong> - dictionary of parameters for the method handler</li>
342
 
    </ul></dd>
343
 
    <dt>Returns:</dt>
344
 
        <dd>output object to send to the view</dd>
345
 
  </dl>
346
 
</td></tr></table>
347
 
</div>
348
 
<a name="_record_id"></a>
349
 
<div class="private">
350
 
<table class="details" border="1" cellpadding="3"
351
 
       cellspacing="0" width="100%" bgcolor="white">
352
 
<tr><td>
353
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
354
 
  <tr valign="top"><td>
355
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_record_id</span>(<span class="sig-arg">r</span>)</span>
356
 
    <br /><em class="fname">Static Method</em>
357
 
  </h3>
358
 
  </td><td align="right" valign="top"
359
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._record_id">source&nbsp;code</a></span>&nbsp;
360
 
    </td>
361
 
  </tr></table>
362
 
  
363
 
  <p>Get the ID of the target record of a S3Request</p>
364
 
  <dl class="fields">
365
 
    <dt>Parameters:</dt>
366
 
    <dd><ul class="nomargin-top">
367
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
368
 
    </ul></dd>
369
 
  </dl>
370
 
</td></tr></table>
371
 
</div>
372
 
<a name="_config"></a>
373
 
<div class="private">
374
 
<table class="details" border="1" cellpadding="3"
375
 
       cellspacing="0" width="100%" bgcolor="white">
376
 
<tr><td>
377
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
378
 
  <tr valign="top"><td>
379
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_config</span>(<span class="sig-arg">self</span>,
380
 
        <span class="sig-arg">key</span>,
381
 
        <span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>
382
 
  </h3>
383
 
  </td><td align="right" valign="top"
384
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._config">source&nbsp;code</a></span>&nbsp;
385
 
    </td>
386
 
  </tr></table>
387
 
  
388
 
  <p>Get a configuration setting of the current table</p>
389
 
  <dl class="fields">
390
 
    <dt>Parameters:</dt>
391
 
    <dd><ul class="nomargin-top">
392
 
        <li><strong class="pname"><code>key</code></strong> - the setting key</li>
393
 
        <li><strong class="pname"><code>default</code></strong> - the default value</li>
394
 
    </ul></dd>
395
 
  </dl>
396
 
</td></tr></table>
397
 
</div>
398
 
<a name="_view"></a>
399
 
<div class="private">
400
 
<table class="details" border="1" cellpadding="3"
401
 
       cellspacing="0" width="100%" bgcolor="white">
402
 
<tr><td>
403
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
404
 
  <tr valign="top"><td>
405
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_view</span>(<span class="sig-arg">r</span>,
406
 
        <span class="sig-arg">default</span>,
407
 
        <span class="sig-arg">format</span>=<span class="sig-default">None</span>)</span>
408
 
    <br /><em class="fname">Static Method</em>
409
 
  </h3>
410
 
  </td><td align="right" valign="top"
411
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._view">source&nbsp;code</a></span>&nbsp;
412
 
    </td>
413
 
  </tr></table>
414
 
  
415
 
  <p>Get the path to the view stylesheet file</p>
416
 
  <dl class="fields">
417
 
    <dt>Parameters:</dt>
418
 
    <dd><ul class="nomargin-top">
419
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
420
 
        <li><strong class="pname"><code>default</code></strong> - name of the default view stylesheet file</li>
421
 
        <li><strong class="pname"><code>format</code></strong> - format string (optional)</li>
422
 
    </ul></dd>
423
 
  </dl>
424
 
</td></tr></table>
425
 
</div>
426
 
<a name="_extend_view"></a>
427
 
<div class="private">
428
 
<table class="details" border="1" cellpadding="3"
429
 
       cellspacing="0" width="100%" bgcolor="white">
430
 
<tr><td>
431
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
432
 
  <tr valign="top"><td>
433
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_extend_view</span>(<span class="sig-arg">output</span>,
434
 
        <span class="sig-arg">r</span>,
435
 
        <span class="sig-arg">**attr</span>)</span>
436
 
    <br /><em class="fname">Static Method</em>
437
 
  </h3>
438
 
  </td><td align="right" valign="top"
439
 
    ><span class="codelink"><a href="vita.modules.s3.s3rest-pysrc.html#S3Method._extend_view">source&nbsp;code</a></span>&nbsp;
440
 
    </td>
441
 
  </tr></table>
442
 
  
443
 
  <p>Add additional view variables (invokes all callables)</p>
444
 
  <dl class="fields">
445
 
    <dt>Parameters:</dt>
446
 
    <dd><ul class="nomargin-top">
447
 
        <li><strong class="pname"><code>output</code></strong> - the output dict</li>
448
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
449
 
        <li><strong class="pname"><code>attr</code></strong> - the view variables (e.g. 'rheader')</li>
450
 
    </ul></dd>
451
 
  </dl>
452
 
<div class="fields">      <p><strong>Note:</strong>
453
 
        overload this method in subclasses if you don't want additional 
454
 
        view variables to be added automatically
455
 
      </p>
456
 
</div></td></tr></table>
457
 
</div>
458
 
<br />
459
 
<!-- ==================== NAVIGATION BAR ==================== -->
460
 
<table class="navbar" border="0" width="100%" cellpadding="0"
461
 
       bgcolor="#a0c0ff" cellspacing="0">
462
 
  <tr valign="middle">
463
 
  <!-- Home link -->
464
 
      <th>&nbsp;&nbsp;&nbsp;<a
465
 
        href="vita.modules.s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
466
 
 
467
 
  <!-- Tree link -->
468
 
      <th>&nbsp;&nbsp;&nbsp;<a
469
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
470
 
 
471
 
  <!-- Index link -->
472
 
      <th>&nbsp;&nbsp;&nbsp;<a
473
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
474
 
 
475
 
  <!-- Help link -->
476
 
      <th>&nbsp;&nbsp;&nbsp;<a
477
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
478
 
 
479
 
  <!-- Project homepage -->
480
 
      <th class="navbar" align="right" width="100%">
481
 
        <table border="0" cellpadding="0" cellspacing="0">
482
 
          <tr><th class="navbar" align="center"
483
 
            ><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
484
 
          </tr></table></th>
485
 
  </tr>
486
 
</table>
487
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
488
 
  <tr>
489
 
    <td align="left" class="footer">
490
 
    Generated by Epydoc 3.0.1 on Tue Mar 29 14:25:41 2011
491
 
    </td>
492
 
    <td align="right" class="footer">
493
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
494
 
        >http://epydoc.sourceforge.net</a>
495
 
    </td>
496
 
  </tr>
497
 
</table>
498
 
 
499
 
<script type="text/javascript">
500
 
  <!--
501
 
  // Private objects are initially displayed (because if
502
 
  // javascript is turned off then we want them to be
503
 
  // visible); but by default, we want to hide them.  So hide
504
 
  // them unless we have a cookie that says to show them.
505
 
  checkCookie();
506
 
  // -->
507
 
</script>
508
 
</body>
509
 
</html>