1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2003 Tim Joyce
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Tim Joyce <timj At paneris.org>
42 * http://paneris.org/~timj
43 */
44
45 package org.melati.poem;
46
47 /**
48 * An object which can be persisted, ie has a Troid.
49 *
50 */
51 public interface Persistable {
52
53 /**
54 * The object's troid, returned after access check.
55 *
56 * @return Every record (object) in a POEM database must have a
57 * troid (table row ID, or table-unique non-nullable integer primary
58 * key), often but not necessarily called <TT>id</TT>, so that it can
59 * be conveniently `named' for retrieval.
60 *
61 * @exception AccessPoemException
62 * if <TT>assertCanRead</TT> fails
63 *
64 * @see Table#getObject(java.lang.Integer)
65 * @see Persistent#getTroid()
66 */
67 Integer getTroid() throws AccessPoemException;
68
69 /**
70 * Get the troid without access checking.
71 * @return the troid
72 */
73 Integer troid();
74 }