| 3409 |
30 May 07 |
nicklas |
1 |
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 3409 |
30 May 07 |
nicklas |
2 |
|
| 3409 |
30 May 07 |
nicklas |
3 |
<!-- |
| 3409 |
30 May 07 |
nicklas |
4 |
$Id$ |
| 3409 |
30 May 07 |
nicklas |
5 |
|
| 3675 |
16 Aug 07 |
jari |
Copyright (C) 2007 Nicklas Nordborg |
| 3409 |
30 May 07 |
nicklas |
7 |
|
| 3409 |
30 May 07 |
nicklas |
8 |
This file is part of BASE - BioArray Software Environment. |
| 3409 |
30 May 07 |
nicklas |
9 |
Available at http://base.thep.lu.se/ |
| 3409 |
30 May 07 |
nicklas |
10 |
|
| 3409 |
30 May 07 |
nicklas |
11 |
BASE is free software; you can redistribute it and/or modify it |
| 3409 |
30 May 07 |
nicklas |
12 |
under the terms of the GNU General Public License as published by |
| 4477 |
05 Sep 08 |
jari |
13 |
the Free Software Foundation; either version 3 of the License, or |
| 3409 |
30 May 07 |
nicklas |
14 |
(at your option) any later version. |
| 3409 |
30 May 07 |
nicklas |
15 |
|
| 3409 |
30 May 07 |
nicklas |
16 |
BASE is distributed in the hope that it will be useful, but |
| 3409 |
30 May 07 |
nicklas |
17 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 3409 |
30 May 07 |
nicklas |
18 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 3409 |
30 May 07 |
nicklas |
19 |
General Public License for more details. |
| 3409 |
30 May 07 |
nicklas |
20 |
|
| 3409 |
30 May 07 |
nicklas |
21 |
You should have received a copy of the GNU General Public License |
| 4509 |
11 Sep 08 |
jari |
22 |
along with BASE. If not, see <http://www.gnu.org/licenses/>. |
| 3409 |
30 May 07 |
nicklas |
23 |
--> |
| 3409 |
30 May 07 |
nicklas |
24 |
|
| 3409 |
30 May 07 |
nicklas |
25 |
<body> |
| 8001 |
11 Aug 21 |
nicklas |
26 |
<h1>The BASE API</h1> |
| 3409 |
30 May 07 |
nicklas |
27 |
|
| 3409 |
30 May 07 |
nicklas |
28 |
<p> |
| 3409 |
30 May 07 |
nicklas |
29 |
The <b>Public API</b> is intended to be used by client application |
| 3409 |
30 May 07 |
nicklas |
30 |
or plug-in developers. We guarantee a certain degree of stability |
| 3409 |
30 May 07 |
nicklas |
31 |
among the classes and methods in the public API. See documentation |
| 7982 |
14 Jun 21 |
nicklas |
32 |
on the <a href="https://base.thep.lu.se/chrome/site/doc/docbook/html/developerdoc/api/api_overview.html" |
| 3415 |
31 May 07 |
nicklas |
33 |
>BASE web site</a> for more information. |
| 3415 |
31 May 07 |
nicklas |
34 |
Methods that have been tagged as <code>@deprecated</code> should be considered |
| 3415 |
31 May 07 |
nicklas |
35 |
part of the internal API and may be removed without warning in |
| 3415 |
31 May 07 |
nicklas |
36 |
a later release. |
| 3409 |
30 May 07 |
nicklas |
37 |
</p> |
| 3409 |
30 May 07 |
nicklas |
38 |
|
| 3409 |
30 May 07 |
nicklas |
39 |
<p> |
| 3409 |
30 May 07 |
nicklas |
40 |
The <b>Extension API</b> is intended to be used by developers extending |
| 3409 |
30 May 07 |
nicklas |
41 |
the internal BASE functionality. The classes and interfaces in these packages |
| 3409 |
30 May 07 |
nicklas |
42 |
are not intended to be used by plug-ins or client applications. |
| 3409 |
30 May 07 |
nicklas |
43 |
</p> |
| 3409 |
30 May 07 |
nicklas |
44 |
|
| 3409 |
30 May 07 |
nicklas |
45 |
<p> |
| 3409 |
30 May 07 |
nicklas |
46 |
The <b>Internal API</b> contains code used by the internal implementation |
| 3409 |
30 May 07 |
nicklas |
47 |
of BASE. Client applications and plug-ins should not use the classes |
| 3409 |
30 May 07 |
nicklas |
48 |
and methods in theese packages. |
| 3409 |
30 May 07 |
nicklas |
49 |
</p> |
| 3409 |
30 May 07 |
nicklas |
50 |
|
| 3409 |
30 May 07 |
nicklas |
51 |
<p> |
| 3409 |
30 May 07 |
nicklas |
52 |
The <b>Mixed Public and Internal API</b> packages contains some |
| 3409 |
30 May 07 |
nicklas |
53 |
classes that belong to the <b>Public API</b> and some classes that |
| 3409 |
30 May 07 |
nicklas |
54 |
belong to the <b>Internal API</b>. |
| 3409 |
30 May 07 |
nicklas |
55 |
</p> |
| 3409 |
30 May 07 |
nicklas |
56 |
|
| 3409 |
30 May 07 |
nicklas |
57 |
<ul> |
| 3409 |
30 May 07 |
nicklas |
58 |
<li> |
| 3409 |
30 May 07 |
nicklas |
59 |
In <code>net.sf.basedb.core.data</code> the <code>BatchableData</code> |
| 3409 |
30 May 07 |
nicklas |
60 |
interface and all classes that implements it part of the public API. |
| 3409 |
30 May 07 |
nicklas |
61 |
</li> |
| 3409 |
30 May 07 |
nicklas |
62 |
|
| 3409 |
30 May 07 |
nicklas |
63 |
<li> |
| 3409 |
30 May 07 |
nicklas |
64 |
The <code>net.sf.basedb.clients.web.util.HTML</code> is part of |
| 3409 |
30 May 07 |
nicklas |
65 |
the public API. |
| 3409 |
30 May 07 |
nicklas |
66 |
</li> |
| 3409 |
30 May 07 |
nicklas |
67 |
|
| 3409 |
30 May 07 |
nicklas |
68 |
<li> |
| 3409 |
30 May 07 |
nicklas |
69 |
The <code>net.sf.basedb.clients.web.Base</code> and |
| 3409 |
30 May 07 |
nicklas |
70 |
<code>net.sf.basedb.clients.web.WebException</code> are part of |
| 3409 |
30 May 07 |
nicklas |
71 |
the public API. |
| 3409 |
30 May 07 |
nicklas |
72 |
</li> |
| 3409 |
30 May 07 |
nicklas |
73 |
</ul> |
| 3409 |
30 May 07 |
nicklas |
74 |
|
| 3409 |
30 May 07 |
nicklas |
75 |
<p> |
| 3409 |
30 May 07 |
nicklas |
76 |
All other classes in are part of the internal API. |
| 3409 |
30 May 07 |
nicklas |
77 |
</p> |
| 3409 |
30 May 07 |
nicklas |
78 |
|
| 3409 |
30 May 07 |
nicklas |
79 |
</body> |