KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ivata > groupware > admin > security > user > UserEvent


1 /*
2  * Copyright (c) 2001 - 2005 ivata limited.
3  * All rights reserved.
4  * -----------------------------------------------------------------------------
5  * ivata groupware may be redistributed under the GNU General Public
6  * License as published by the Free Software Foundation;
7  * version 2 of the License.
8  *
9  * These programs are free software; you can redistribute them and/or
10  * modify them under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; version 2 of the License.
12  *
13  * These programs are distributed in the hope that they will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  * See the GNU General Public License in the file LICENSE.txt for more
18  * details.
19  *
20  * If you would like a copy of the GNU General Public License write to
21  *
22  * Free Software Foundation, Inc.
23  * 59 Temple Place - Suite 330
24  * Boston, MA 02111-1307, USA.
25  *
26  *
27  * To arrange commercial support and licensing, contact ivata at
28  * http://www.ivata.com/contact.jsp
29  * -----------------------------------------------------------------------------
30  * $Log: UserEvent.java,v $
31  * Revision 1.3 2005/04/10 18:47:41 colinmacleod
32  * Changed i tag to em and b tag to strong.
33  *
34  * Revision 1.2 2005/04/09 17:19:57 colinmacleod
35  * Changed copyright text to GPL v2 explicitly.
36  *
37  * Revision 1.1.1.1 2005/03/10 17:51:42 colinmacleod
38  * Restructured ivata op around Hibernate/PicoContainer.
39  * Renamed ivata groupware.
40  *
41  * Revision 1.1 2004/09/30 15:15:59 colinmacleod
42  * Split off addressbook elements into security subproject.
43  *
44  * Revision 1.1 2004/07/13 19:15:26 colinmacleod
45  * Moved from business.addressbook to admin.security.
46  *
47  * Revision 1.2 2004/03/21 21:16:07 colinmacleod
48  * Shortened name to ivata op.
49  *
50  * Revision 1.1.1.1 2004/01/27 20:57:52 colinmacleod
51  * Moved ivata openportal to SourceForge..
52  *
53  * Revision 1.2 2003/10/15 13:18:02 colin
54  * fixing for XDoclet
55  * -----------------------------------------------------------------------------
56  */
57 package com.ivata.groupware.admin.security.user;
58
59 import com.ivata.groupware.business.event.Event;
60
61 /**
62  * <p>To implement a specific event with detail specific to your system, you
63  * need to extend this class.</p>
64  *
65  * @author Colin MacLeod
66  * <a HREF='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
67  */
68 public class UserEvent extends Event {
69     /**
70      * <p>Stores the user name for the user this event relates to.</p>
71      */
72     private String JavaDoc userName = null;
73
74     /**
75      * <p>Construct an event and set the name of the <em>JMS</em> topic associated
76      * with this event.</p>
77      *
78      * @param userName the name of the user with whom this event is associated.
79      * @param topic set to one of the constants in <code>UserEventConstants</code>.
80      * @see com.ivata.groupware.business.addressbook.person.group.right.RightConstants
81      */
82     public UserEvent(String JavaDoc userNameParam, String JavaDoc topic) {
83         super(topic);
84         userName = userNameParam;
85     }
86
87     /**
88      * <p>Get the user name for the user this event relates to.</p>
89      *
90      * @return the user name for the user this event relates to.</p>
91      */
92     public final String JavaDoc getUserName() {
93         return userName;
94     }
95
96 }
97
Popular Tags