source: trunk/src/info/net/sf/basedb/info/package.html @ 3974

Last change on this file since 3974 was 3974, checked in by Nicklas Nordborg, 15 years ago

References #827: Add more web services methods

Added Transferable and ToTransferable? to make it easier to write generic code for populating classes that are going to be transfered with web services.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 2.2 KB
Line 
1<!--
2  $Id: package.html 3974 2007-11-16 08:28:40Z nicklas $
3
4  Copyright (C) 2007 Nicklas Nordborg
5
6  This file is part of BASE - BioArray Software Environment.
7  Available at http://base.thep.lu.se/
8
9  BASE is free software; you can redistribute it and/or
10  modify it under the terms of the GNU General Public License
11  as published by the Free Software Foundation; either version 2
12  of the License, or (at your option) any later version.
13
14  BASE is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  GNU General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 59 Temple Place - Suite 330,
22  Boston, MA  02111-1307, USA.
23-->
24<body>
25<p>
26  This package contains pure data-holder classes which are used
27  for transporting information about items in the database. These
28  classes are, for example, used by the webservices implementation, but
29  can also be used by other clients with similar needs. The classes
30  are {@link java.io.Serializable} and {@link net.sf.basedb.info.Transferable}.
31</p>
32<p>
33  The code in this package does not include any business logic, data validation,
34  error handling, database queries or other complext code. It is the repsonsibility
35  of the business layer (the {@link net.sf.basedb.core} package) to perform those tasks.
36  For each class in this package, there usually is a corresponding class
37  in the business layer, for example {@link net.sf.basedb.info.ProjectInfo} and
38  {@link net.sf.basedb.core.Project}.
39</p>
40<p>
41  Client applications can create and initialise instances themselves or use the
42  {@link net.sf.basedb.info.ToTransferable#toTransferable(net.sf.basedb.info.Transferable)}
43  method to let the core initialise an instance. Note! The latter
44  alternative will of course only work for code executing on the server.
45  It will, for example, not work in the webservices client since it doesn't
46  have access to the BASE core code.
47</p>
48<p>
49  NOTE! IT IS VERY IMPORTANT THAT THE CLASSES IN THIS PACKAGE ARE INDEPENDENT
50  OF ALL OTHER PACKAGES IN BASE. IT IS FORBIDDEN TO IMPORT FROM net.sf.basedb.core
51  AND ALL OTHER net.sf.basedb.* PACKAGES.
52</p>
53
54</body>
Note: See TracBrowser for help on using the repository browser.