KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > main > CmsBroadcast


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/main/CmsBroadcast.java,v $
3  * Date : $Date: 2005/06/23 11:11:38 $
4  * Version: $Revision: 1.7 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.main;
33
34 import org.opencms.file.CmsUser;
35
36 /**
37  * A single broadcast message, send from one OpenCms user to another.<p>
38  *
39  * To addess a broadcast to another user, it must be placed in the
40  * broadcast queue of that user using for example
41  * {@link org.opencms.main.CmsSessionManager#sendBroadcast(org.opencms.file.CmsObject, String, CmsUser)}.<p>
42  *
43  * @author Alexander Kandzior
44  *
45  * @version $Revision: 1.7 $
46  *
47  * @since 6.0.0
48  */
49 public class CmsBroadcast {
50
51     /** The broadcast content. */
52     private String JavaDoc m_message;
53
54     /** The sender of the broadcast. */
55     private CmsUser m_sender;
56
57     /** Time the broadcast was send. */
58     private long m_sendTime;
59
60     /**
61      * Creates a new broadcast, with the current system time set as send time.<p>
62      *
63      * @param sender the sender of the broadcast
64      * @param message the message to send
65      */
66     public CmsBroadcast(CmsUser sender, String JavaDoc message) {
67
68         m_sender = sender;
69         m_message = message;
70         m_sendTime = System.currentTimeMillis();
71     }
72
73     /**
74      * Returns the broadcast message content.<p>
75      *
76      * @return the broadcast message content
77      */
78     public String JavaDoc getMessage() {
79
80         return m_message;
81     }
82
83     /**
84      * Returns the time this broadcast was send.<p>
85      *
86      * @return the time this broadcast was send
87      */
88     public long getSendTime() {
89
90         return m_sendTime;
91     }
92
93     /**
94      * Returns the user that was the sender of this broadcast.<p>
95      *
96      * @return the user that was the sender of this broadcast
97      */
98     public CmsUser getUser() {
99
100         return m_sender;
101     }
102 }
Popular Tags