View Javadoc
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@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.GroupMembershipBase;
49  
50  /**
51   * A record of a {@link User}'s belonging to a {@link Group}.
52   * 
53   * Melati POEM generated, programmer modifiable stub 
54   * for a <code>Persistent</code> <code>GroupMembership</code> object.
55   * 
56   * <p> 
57   * Description: 
58   *   A record that a given user is a member of a given group. 
59   * </p>
60   * 
61   * <table> 
62   * <caption>
63   * Field summary for SQL table <code>GroupMembership</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> user </td><td> User </td><td> The user who belongs to the group 
68   * </td></tr> 
69   * <tr><td> group </td><td> Group </td><td> The group to which the user 
70   * belongs </td></tr> 
71   * </table> 
72   * 
73   * See org.melati.poem.prepro.TableDef#generateMainJava 
74   */
75  
76  public class GroupMembership extends GroupMembershipBase {
77  
78   /**
79    * Constructor 
80    * for a <code>Persistent</code> <code>GroupMembership</code> object.
81    * <p>
82    * Description: 
83    *   A record that a given user is a member of a given group. 
84    * </p>
85    * 
86    * See org.melati.poem.prepro.TableDef#generateMainJava 
87    */
88    public GroupMembership() { }
89  
90    // programmer's domain-specific code here
91  
92   /**
93    * Constructor 
94    * for a <code>Persistent</code> <code>GroupMembership</code> object.
95    * <p>
96    * Description: 
97    *   A record that a given user is a member of a given group. 
98    * </p>
99    * 
100   * @param user a {@link User}
101   * @param group a {@link Group}
102   */
103   public GroupMembership(User user, Group group) {
104     this.user = user.troid();
105     this.group = group.troid();
106   }
107 
108  /**
109   * Constructor 
110   * for a <code>Persistent</code> <code>GroupMembership</code> object.
111   * <p>
112   * Description: 
113   *   A record that a given user is a member of a given group. 
114   * </p>
115   * 
116   * @param user a raw troid value representing a {@link User}
117   * @param group a raw troid value representing a {@link Group}
118   */
119   public GroupMembership(Integer user, Integer group) {
120     this.user = user;
121     this.group = group;
122   }
123 }