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">
6
<title>vita.modules.s3.s3search.S3Search</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="vita.modules.s3-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
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>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
46
Package modules ::
47
<a href="vita.modules.s3-module.html">Package s3</a> ::
48
<a href="vita.modules.s3.s3search-module.html">Module s3search</a> ::
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 private</a>]</span></td></tr>
57
<tr><td align="right"><span class="options"
58
>[<a href="frames.html" target="_top">frames</a
59
>] | <a href="vita.modules.s3.s3search.S3Search-class.html"
60
target="_top">no frames</a>]</span></td></tr>
65
<!-- ==================== CLASS DESCRIPTION ==================== -->
66
<h1 class="epydoc">Class S3Search</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search">source code</a></span></p>
67
<pre class="base-tree">
70
<a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a> --+
72
<a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a> --+
74
<strong class="uidshort">S3Search</strong>
78
<p>RESTful Search Method for S3Resources</p>
80
<!-- ==================== INSTANCE METHODS ==================== -->
81
<a name="section-InstanceMethods"></a>
82
<table class="summary" border="1" cellpadding="3"
83
cellspacing="0" width="100%" bgcolor="white">
84
<tr bgcolor="#70b0f0" class="table-header">
85
<td colspan="2" class="table-header">
86
<table border="0" cellpadding="0" cellspacing="0" width="100%">
88
<td align="left"><span class="table-header">Instance Methods</span></td>
89
<td align="right" valign="top"
90
><span class="options">[<a href="#section-InstanceMethods"
91
class="privatelink" onclick="toggle_private();"
92
>hide private</a>]</span></td>
98
<td width="15%" align="right" valign="top" class="summary">
99
<span class="summary-type"> </span>
100
</td><td class="summary">
101
<table width="100%" cellpadding="0" cellspacing="0" border="0">
103
<td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
104
<span class="summary-sig-arg">simple</span>=<span class="summary-sig-default">None</span>,
105
<span class="summary-sig-arg">advanced</span>=<span class="summary-sig-default">None</span>,
106
<span class="summary-sig-arg">any</span>=<span class="summary-sig-default">False</span>,
107
<span class="summary-sig-arg">**args</span>)</span><br />
109
<td align="right" valign="top">
110
<span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.__init__">source code</a></span>
119
<td width="15%" align="right" valign="top" class="summary">
120
<span class="summary-type"> </span>
121
</td><td class="summary">
122
<table width="100%" cellpadding="0" cellspacing="0" border="0">
124
<td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#apply_method" class="summary-sig-name">apply_method</a>(<span class="summary-sig-arg">self</span>,
125
<span class="summary-sig-arg">r</span>,
126
<span class="summary-sig-arg">**attr</span>)</span><br />
127
Entry point to apply search method to S3Requests</td>
128
<td align="right" valign="top">
129
<span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.apply_method">source code</a></span>
138
<td width="15%" align="right" valign="top" class="summary">
139
<span class="summary-type"> </span>
140
</td><td class="summary">
141
<table width="100%" cellpadding="0" cellspacing="0" border="0">
143
<td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#search_interactive" class="summary-sig-name">search_interactive</a>(<span class="summary-sig-arg">self</span>,
144
<span class="summary-sig-arg">r</span>,
145
<span class="summary-sig-arg">**attr</span>)</span><br />
146
Interactive search</td>
147
<td align="right" valign="top">
148
<span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_interactive">source code</a></span>
157
<td width="15%" align="right" valign="top" class="summary">
158
<span class="summary-type"> </span>
159
</td><td class="summary">
160
<table width="100%" cellpadding="0" cellspacing="0" border="0">
162
<td><span class="summary-sig"><a href="vita.modules.s3.s3search.S3Search-class.html#search_json" class="summary-sig-name">search_json</a>(<span class="summary-sig-arg">self</span>,
163
<span class="summary-sig-arg">r</span>,
164
<span class="summary-sig-arg">**attr</span>)</span><br />
165
Legacy JSON search method (for autocomplete-widgets)</td>
166
<td align="right" valign="top">
167
<span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_json">source code</a></span>
176
<td colspan="2" class="summary">
177
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b>:
178
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#create">create</a></code>,
179
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#crud_button">crud_button</a></code>,
180
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#crud_string">crud_string</a></code>,
181
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#delete">delete</a></code>,
182
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#insert_buttons">insert_buttons</a></code>,
183
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#last_update">last_update</a></code>,
184
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#read">read</a></code>,
185
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#select">select</a></code>,
186
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#sqlform">sqlform</a></code>,
187
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#sqltable">sqltable</a></code>,
188
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#ssp_filter">ssp_filter</a></code>,
189
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#ssp_orderby">ssp_orderby</a></code>,
190
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#update">update</a></code>
192
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b> (private):
193
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#_linkto" onclick="show_private();">_linkto</a></code>
195
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b>:
196
<code><a href="vita.modules.s3.s3rest.S3Method-class.html#__call__">__call__</a></code>
198
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
199
<code><a href="vita.modules.s3.s3rest.S3Method-class.html#_config" onclick="show_private();">_config</a></code>
201
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
202
<code>__delattr__</code>,
203
<code>__format__</code>,
204
<code>__getattribute__</code>,
205
<code>__hash__</code>,
206
<code>__new__</code>,
207
<code>__reduce__</code>,
208
<code>__reduce_ex__</code>,
209
<code>__repr__</code>,
210
<code>__setattr__</code>,
211
<code>__sizeof__</code>,
212
<code>__str__</code>,
213
<code>__subclasshook__</code>
218
<!-- ==================== STATIC METHODS ==================== -->
219
<a name="section-StaticMethods"></a>
220
<table class="summary" border="1" cellpadding="3"
221
cellspacing="0" width="100%" bgcolor="white">
222
<tr bgcolor="#70b0f0" class="table-header">
223
<td colspan="2" class="table-header">
224
<table border="0" cellpadding="0" cellspacing="0" width="100%">
226
<td align="left"><span class="table-header">Static Methods</span></td>
227
<td align="right" valign="top"
228
><span class="options">[<a href="#section-StaticMethods"
229
class="privatelink" onclick="toggle_private();"
230
>hide private</a>]</span></td>
236
<td colspan="2" class="summary">
237
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3crud.S3CRUD-class.html">s3crud.S3CRUD</a></code></b>:
238
<code><a href="vita.modules.s3.s3crud.S3CRUD-class.html#insert_subheadings">insert_subheadings</a></code>
240
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
241
<code><a href="vita.modules.s3.s3rest.S3Method-class.html#_extend_view" onclick="show_private();">_extend_view</a></code>,
242
<code><a href="vita.modules.s3.s3rest.S3Method-class.html#_record_id" onclick="show_private();">_record_id</a></code>,
243
<code><a href="vita.modules.s3.s3rest.S3Method-class.html#_view" onclick="show_private();">_view</a></code>
248
<!-- ==================== PROPERTIES ==================== -->
249
<a name="section-Properties"></a>
250
<table class="summary" border="1" cellpadding="3"
251
cellspacing="0" width="100%" bgcolor="white">
252
<tr bgcolor="#70b0f0" class="table-header">
253
<td colspan="2" class="table-header">
254
<table border="0" cellpadding="0" cellspacing="0" width="100%">
256
<td align="left"><span class="table-header">Properties</span></td>
257
<td align="right" valign="top"
258
><span class="options">[<a href="#section-Properties"
259
class="privatelink" onclick="toggle_private();"
260
>hide private</a>]</span></td>
266
<td colspan="2" class="summary">
267
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
268
<code>__class__</code>
273
<!-- ==================== METHOD DETAILS ==================== -->
274
<a name="section-MethodDetails"></a>
275
<table class="details" border="1" cellpadding="3"
276
cellspacing="0" width="100%" bgcolor="white">
277
<tr bgcolor="#70b0f0" class="table-header">
278
<td colspan="2" class="table-header">
279
<table border="0" cellpadding="0" cellspacing="0" width="100%">
281
<td align="left"><span class="table-header">Method Details</span></td>
282
<td align="right" valign="top"
283
><span class="options">[<a href="#section-MethodDetails"
284
class="privatelink" onclick="toggle_private();"
285
>hide private</a>]</span></td>
291
<a name="__init__"></a>
293
<table class="details" border="1" cellpadding="3"
294
cellspacing="0" width="100%" bgcolor="white">
296
<table width="100%" cellpadding="0" cellspacing="0" border="0">
297
<tr valign="top"><td>
298
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
299
<span class="sig-arg">simple</span>=<span class="sig-default">None</span>,
300
<span class="sig-arg">advanced</span>=<span class="sig-default">None</span>,
301
<span class="sig-arg">any</span>=<span class="sig-default">False</span>,
302
<span class="sig-arg">**args</span>)</span>
303
<br /><em class="fname">(Constructor)</em>
305
</td><td align="right" valign="top"
306
><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.__init__">source code</a></span>
313
<dd><ul class="nomargin-top">
314
<li><strong class="pname"><code>simple</code></strong> - the widgets for the simple search form as list</li>
315
<li><strong class="pname"><code>advanced</code></strong> - the widgets for the advanced search form as list</li>
316
<li><strong class="pname"><code>any</code></strong> - match "any of" (True) or "all of" (False) the
317
options in advanced search</li>
325
<a name="apply_method"></a>
327
<table class="details" border="1" cellpadding="3"
328
cellspacing="0" width="100%" bgcolor="white">
330
<table width="100%" cellpadding="0" cellspacing="0" border="0">
331
<tr valign="top"><td>
332
<h3 class="epydoc"><span class="sig"><span class="sig-name">apply_method</span>(<span class="sig-arg">self</span>,
333
<span class="sig-arg">r</span>,
334
<span class="sig-arg">**attr</span>)</span>
336
</td><td align="right" valign="top"
337
><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.apply_method">source code</a></span>
341
<p>Entry point to apply search method to S3Requests</p>
344
<dd><ul class="nomargin-top">
345
<li><strong class="pname"><code>r</code></strong> - the S3Request</li>
346
<li><strong class="pname"><code>attr</code></strong> - request attributes</li>
349
<dd>output object to send to the view</dd>
351
<a href="vita.modules.s3.s3rest.S3Method-class.html#apply_method">s3rest.S3Method.apply_method</a>
356
<a name="search_interactive"></a>
358
<table class="details" border="1" cellpadding="3"
359
cellspacing="0" width="100%" bgcolor="white">
361
<table width="100%" cellpadding="0" cellspacing="0" border="0">
362
<tr valign="top"><td>
363
<h3 class="epydoc"><span class="sig"><span class="sig-name">search_interactive</span>(<span class="sig-arg">self</span>,
364
<span class="sig-arg">r</span>,
365
<span class="sig-arg">**attr</span>)</span>
367
</td><td align="right" valign="top"
368
><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_interactive">source code</a></span>
372
<p>Interactive search</p>
375
<dd><ul class="nomargin-top">
376
<li><strong class="pname"><code>r</code></strong> - the S3Request instance</li>
377
<li><strong class="pname"><code>attr</code></strong> - request parameters</li>
382
<a name="search_json"></a>
384
<table class="details" border="1" cellpadding="3"
385
cellspacing="0" width="100%" bgcolor="white">
387
<table width="100%" cellpadding="0" cellspacing="0" border="0">
388
<tr valign="top"><td>
389
<h3 class="epydoc"><span class="sig"><span class="sig-name">search_json</span>(<span class="sig-arg">self</span>,
390
<span class="sig-arg">r</span>,
391
<span class="sig-arg">**attr</span>)</span>
393
</td><td align="right" valign="top"
394
><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html#S3Search.search_json">source code</a></span>
398
<p>Legacy JSON search method (for autocomplete-widgets)</p>
401
<dd><ul class="nomargin-top">
402
<li><strong class="pname"><code>r</code></strong> - the S3Request</li>
403
<li><strong class="pname"><code>attr</code></strong> - request attributes</li>
409
<!-- ==================== NAVIGATION BAR ==================== -->
410
<table class="navbar" border="0" width="100%" cellpadding="0"
411
bgcolor="#a0c0ff" cellspacing="0">
414
<th> <a
415
href="vita.modules.s3-module.html">Home</a> </th>
418
<th> <a
419
href="module-tree.html">Trees</a> </th>
422
<th> <a
423
href="identifier-index.html">Indices</a> </th>
426
<th> <a
427
href="help.html">Help</a> </th>
429
<!-- Project homepage -->
430
<th class="navbar" align="right" width="100%">
431
<table border="0" cellpadding="0" cellspacing="0">
432
<tr><th class="navbar" align="center"
433
><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
437
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
439
<td align="left" class="footer">
440
Generated by Epydoc 3.0.1 on Tue Mar 29 14:25:41 2011
442
<td align="right" class="footer">
443
<a target="mainFrame" href="http://epydoc.sourceforge.net"
444
>http://epydoc.sourceforge.net</a>
449
<script type="text/javascript">
451
// Private objects are initially displayed (because if
452
// javascript is turned off then we want them to be
453
// visible); but by default, we want to hide them. So hide
454
// them unless we have a cookie that says to show them.