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</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> ::
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55
onclick="toggle_private();">hide private</a>]</span></td></tr>
56
<tr><td align="right"><span class="options"
57
>[<a href="frames.html" target="_top">frames</a
58
>] | <a href="vita.modules.s3.s3search-module.html"
59
target="_top">no frames</a>]</span></td></tr>
64
<!-- ==================== MODULE DESCRIPTION ==================== -->
65
<h1 class="epydoc">Module s3search</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3.s3search-pysrc.html">source code</a></span></p>
66
<p>RESTful Search Methods</p>
69
<div class="fields"> <dl><dt>Authors:</dt>
71
Fran Boon <fran[at]aidiq.com>,
72
Dominic König <dominic[at]aidiq.com>
75
<p><strong>Requires:</strong>
76
<a href="http://web2py.com" target="_top"><b><i>gluon</i></b></a>
78
<p><strong>Copyright:</strong>
79
2009-2011 (c) Sahana Software Foundation
81
<p><strong>License:</strong>
84
<p><strong>Status:</strong>
86
<p>Permission is hereby granted, free of charge, to any person
87
obtaining a copy of this software and associated documentation
88
files (the "Software"), to deal in the Software without
89
restriction, including without limitation the rights to use, copy,
90
modify, merge, publish, distribute, sublicense, and/or sell copies
91
of the Software, and to permit persons to whom the Software is
92
furnished to do so, subject to the following conditions:</p>
93
<p>The above copyright notice and this permission notice shall be
94
included in all copies or substantial portions of the Software.</p>
95
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
96
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
97
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
98
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
99
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
100
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
101
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
104
</div><!-- ==================== CLASSES ==================== -->
105
<a name="section-Classes"></a>
106
<table class="summary" border="1" cellpadding="3"
107
cellspacing="0" width="100%" bgcolor="white">
108
<tr bgcolor="#70b0f0" class="table-header">
109
<td colspan="2" class="table-header">
110
<table border="0" cellpadding="0" cellspacing="0" width="100%">
112
<td align="left"><span class="table-header">Classes</span></td>
113
<td align="right" valign="top"
114
><span class="options">[<a href="#section-Classes"
115
class="privatelink" onclick="toggle_private();"
116
>hide private</a>]</span></td>
122
<td width="15%" align="right" valign="top" class="summary">
123
<span class="summary-type"> </span>
124
</td><td class="summary">
125
<a href="vita.modules.s3.s3search.S3SearchWidget-class.html" class="summary-name">S3SearchWidget</a><br />
126
Search Widget for interactive search (base class)
130
<td width="15%" align="right" valign="top" class="summary">
131
<span class="summary-type"> </span>
132
</td><td class="summary">
133
<a href="vita.modules.s3.s3search.S3SearchSimpleWidget-class.html" class="summary-name">S3SearchSimpleWidget</a><br />
134
Simple full-text search widget
138
<td width="15%" align="right" valign="top" class="summary">
139
<span class="summary-type"> </span>
140
</td><td class="summary">
141
<a href="vita.modules.s3.s3search.S3SearchMatchWidget-class.html" class="summary-name">S3SearchMatchWidget</a><br />
146
<td width="15%" align="right" valign="top" class="summary">
147
<span class="summary-type"> </span>
148
</td><td class="summary">
149
<a href="vita.modules.s3.s3search.S3SearchMinMaxWidget-class.html" class="summary-name">S3SearchMinMaxWidget</a><br />
150
Min/Max search widget for numeric fields
154
<td width="15%" align="right" valign="top" class="summary">
155
<span class="summary-type"> </span>
156
</td><td class="summary">
157
<a href="vita.modules.s3.s3search.S3SearchSelectWidget-class.html" class="summary-name">S3SearchSelectWidget</a><br />
158
Option select widget for option or boolean fields
162
<td width="15%" align="right" valign="top" class="summary">
163
<span class="summary-type"> </span>
164
</td><td class="summary">
165
<a href="vita.modules.s3.s3search.S3SearchLocationWidget-class.html" class="summary-name">S3SearchLocationWidget</a><br />
166
Interactive location search widget
170
<td width="15%" align="right" valign="top" class="summary">
171
<span class="summary-type"> </span>
172
</td><td class="summary">
173
<a href="vita.modules.s3.s3search.S3Search-class.html" class="summary-name">S3Search</a><br />
174
RESTful Search Method for S3Resources
178
<td width="15%" align="right" valign="top" class="summary">
179
<span class="summary-type"> </span>
180
</td><td class="summary">
181
<a href="vita.modules.s3.s3search.S3LocationSearch-class.html" class="summary-name">S3LocationSearch</a><br />
182
Search method with specifics for location records (hierarchy search)
186
<td width="15%" align="right" valign="top" class="summary">
187
<span class="summary-type"> </span>
188
</td><td class="summary">
189
<a href="vita.modules.s3.s3search.S3PersonSearch-class.html" class="summary-name">S3PersonSearch</a><br />
190
Search method with specifics for person records (full name search)
194
<!-- ==================== NAVIGATION BAR ==================== -->
195
<table class="navbar" border="0" width="100%" cellpadding="0"
196
bgcolor="#a0c0ff" cellspacing="0">
199
<th> <a
200
href="vita.modules.s3-module.html">Home</a> </th>
203
<th> <a
204
href="module-tree.html">Trees</a> </th>
207
<th> <a
208
href="identifier-index.html">Indices</a> </th>
211
<th> <a
212
href="help.html">Help</a> </th>
214
<!-- Project homepage -->
215
<th class="navbar" align="right" width="100%">
216
<table border="0" cellpadding="0" cellspacing="0">
217
<tr><th class="navbar" align="center"
218
><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
222
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
224
<td align="left" class="footer">
225
Generated by Epydoc 3.0.1 on Tue Mar 29 14:25:41 2011
227
<td align="right" class="footer">
228
<a target="mainFrame" href="http://epydoc.sourceforge.net"
229
>http://epydoc.sourceforge.net</a>
234
<script type="text/javascript">
236
// Private objects are initially displayed (because if
237
// javascript is turned off then we want them to be
238
// visible); but by default, we want to hide them. So hide
239
// them unless we have a cookie that says to show them.