1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
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 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem;
47
48 import org.melati.poem.generated.CapabilityBase;
49
50 /**
51 * The quality of being able to perform an action.
52 * Melati POEM generated, programmer modifiable stub
53 * for a <code>Persistent</code> <code>Capability</code> object.
54 *
55 * <p>
56 * Description:
57 * A capability which users can be required to possess before accessing
58 * data.
59 * </p>
60 *
61 * <table>
62 * <caption>
63 * Field summary for SQL table <code>Capability</code>
64 * </caption>
65 * <tr><th>Name</th><th>Type</th><th>Description</th></tr>
66 * <tr><td> id </td><td> Integer </td><td> The Table Row Object ID </td></tr>
67 * <tr><td> name </td><td> String </td><td> A human-readable name for the
68 * capability </td></tr>
69 * </table>
70 *
71 * See org.melati.poem.prepro.TableDef#generateMainJava
72 */
73 public class Capability extends CapabilityBase {
74
75 /**
76 * Constructor
77 * for a <code>Persistent</code> <code>Capability</code> object.
78 * <p>
79 * Description:
80 * A capability which users can be required to possess before accessing
81 * data.
82 * </p>
83 *
84 * See org.melati.poem.prepro.TableDef#generateMainJava
85 */
86 public Capability() {
87 }
88
89 // programmer's domain-specific code here
90
91 /**
92 * Constructor
93 * for a <code>Persistent</code> <code>Capability</code> object.
94 * <p>
95 * Description:
96 * A capability which users can be required to possess before accessing
97 * data.
98 * </p>
99 *
100 * @param name the name of a <code>Capability</code> to create.
101 */
102 public Capability(String name) {
103 setName_unsafe(name);
104 }
105
106 /**
107 * Allow this object to be read by anyone.
108 *
109 * @param token any {@link AccessToken}
110 */
111 public void assertCanRead(AccessToken token) {}
112
113 /**
114 * Return the capability name.
115 * @return the name of this <code>Capability</code>
116 */
117 public String toString() {
118 if (PoemThread.inSession()) {
119 return getName();
120 } else {
121 return getName_unsafe();
122 }
123 }
124 }