001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata groupware may be redistributed under the GNU General Public
006: * License as published by the Free Software Foundation;
007: * version 2 of the License.
008: *
009: * These programs are free software; you can redistribute them and/or
010: * modify them under the terms of the GNU General Public License
011: * as published by the Free Software Foundation; version 2 of the License.
012: *
013: * These programs are distributed in the hope that they will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: *
017: * See the GNU General Public License in the file LICENSE.txt for more
018: * details.
019: *
020: * If you would like a copy of the GNU General Public License write to
021: *
022: * Free Software Foundation, Inc.
023: * 59 Temple Place - Suite 330
024: * Boston, MA 02111-1307, USA.
025: *
026: *
027: * To arrange commercial support and licensing, contact ivata at
028: * http://www.ivata.com/contact.jsp
029: * -----------------------------------------------------------------------------
030: * $Log: RightDetailDO.java,v $
031: * Revision 1.6 2005/10/11 18:53:06 colinmacleod
032: * Fixed some checkstyle and javadoc issues.
033: *
034: * Revision 1.5 2005/10/02 14:08:55 colinmacleod
035: * Added/improved log4j logging.
036: *
037: * Revision 1.4 2005/09/14 14:52:02 colinmacleod
038: * Added serialVersionUID.
039: *
040: * Revision 1.3 2005/04/10 20:09:36 colinmacleod
041: * Added new themes.
042: * Changed id type to String.
043: * Changed i tag to em and b tag to strong.
044: * Improved PicoContainerFactory with NanoContainer scripts.
045: *
046: * Revision 1.2 2005/04/09 17:19:08 colinmacleod
047: * Changed copyright text to GPL v2 explicitly.
048: *
049: * Revision 1.1.1.1 2005/03/10 17:50:35 colinmacleod
050: * Restructured ivata op around Hibernate/PicoContainer.
051: * Renamed ivata groupware.
052: *
053: * Revision 1.1 2004/07/13 19:41:14 colinmacleod
054: * Moved project to POJOs from EJBs.
055: * Applied PicoContainer to services layer (replacing session EJBs).
056: * Applied Hibernate to persistence layer (replacing entity EJBs).
057: *
058: * Revision 1.3 2004/03/21 21:16:06 colinmacleod
059: * Shortened name to ivata op.
060: *
061: * Revision 1.2 2004/02/01 22:00:32 colinmacleod
062: * Added full names to author tags
063: *
064: * Revision 1.1.1.1 2004/01/27 20:57:51 colinmacleod
065: * Moved ivata openportal to SourceForge..
066: *
067: * Revision 1.5 2003/11/03 11:28:24 jano
068: * commiting addressbook,
069: * tryinjg to fix deploying problem
070: *
071: * Revision 1.4 2003/10/17 12:36:12 jano
072: * fixing problems with building
073: * converting intranet -> portal
074: * Eclipse building
075: *
076: * Revision 1.3 2003/10/15 13:46:12 jano
077: * converting to XDoclet
078: *
079: * Revision 1.2 2003/10/15 13:18:02 colin
080: * fixing for XDoclet
081: *
082: * Revision 1.3 2003/05/01 12:13:22 jano
083: * tidy up names of sequeneces
084: *
085: * Revision 1.2 2003/02/25 14:38:13 colin
086: * implemented setModified methods on entity beans thro IvataEntityBean
087: * superclass
088: *
089: * Revision 1.1 2003/02/24 19:09:21 colin
090: * moved to business
091: *
092: * Revision 1.5 2003/02/04 17:43:45 colin
093: * copyright notice
094: *
095: * Revision 1.4 2002/09/26 09:54:27 jano
096: * name of sequence
097: *
098: * Revision 1.3 2002/07/04 12:29:28 jano
099: * i put readonly script to CVS and i will commit all SRC directory
100: *
101: * Revision 1.2 2002/06/17 07:29:07 colin
102: * improved and extended javadoc documentation
103: * -----------------------------------------------------------------------------
104: */
105: package com.ivata.groupware.business.addressbook.person.group.right.detail;
106:
107: import org.apache.log4j.Logger;
108:
109: import com.ivata.groupware.container.persistence.BaseDO;
110:
111: /**
112: * <p>Represents details a right for group of people to do something. This
113: * class provides detail explaining in clear text what the right allows.</p>
114: *
115: * @since 2002-05-15
116: * @author Colin MacLeod
117: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
118: * @version $Revision: 1.6 $
119: * @see com.ivata.groupware.adddressbook.person.group.right.RightBean
120: *
121: * @hibernate.class
122: * table="person_group_right_detail"
123: * @hibernate.cache
124: * usage="read-write"
125: */
126: public class RightDetailDO extends BaseDO {
127: /**
128: * Logger for this class.
129: */
130: private static final Logger logger = Logger
131: .getLogger(RightDetailDO.class);
132:
133: /**
134: * Serialization version (for <code>Serializable</code> interface).
135: */
136: private static final long serialVersionUID = 1L;
137: /**
138: * <p>Full and detailed description of the entitlements the right
139: * offers.</p>
140: */
141: private String description;
142: /**
143: * <p>Name of the right is a clear-text field which uniquely which
144: * identifies what it is the group will be allowed to do. This name can
145: * include spaces.</p>
146: */
147: private String name;
148:
149: /**
150: * <p>Get full and detailed description of the entitlements the right
151: * offers.</p>
152: *
153: * @return full and detailed description of the entitlements the right
154: * offers.
155: * @hibernate.property
156: */
157: public final String getDescription() {
158: if (logger.isDebugEnabled()) {
159: logger.debug("getDescription() - start");
160: }
161:
162: if (logger.isDebugEnabled()) {
163: logger.debug("getDescription() - end - return value = "
164: + description);
165: }
166: return description;
167: }
168:
169: /**
170: * <p>Get the name of the right is a clear-text field which uniquely which
171: * identifies what it is the group will be allowed to do. This name can
172: * include spaces.</p>
173: *
174: * @return clear text name of the right, possibly including spaces.
175: * @hibernate.property
176: */
177: public final String getName() {
178: if (logger.isDebugEnabled()) {
179: logger.debug("getName() - start");
180: }
181:
182: if (logger.isDebugEnabled()) {
183: logger.debug("getName() - end - return value = " + name);
184: }
185: return name;
186: }
187:
188: /**
189: * <p>
190: * Set full and detailed description of the entitlements the right offers.
191: * </p>
192: *
193: * @param descriptionParam full and detailed description of the entitlements
194: * the right offers.
195: */
196: public final void setDescription(final String descriptionParam) {
197: if (logger.isDebugEnabled()) {
198: logger.debug("setDescription(String description = "
199: + descriptionParam + ") - start");
200: }
201:
202: this .description = descriptionParam;
203:
204: if (logger.isDebugEnabled()) {
205: logger.debug("setDescription(String) - end");
206: }
207: }
208:
209: /**
210: * <p>Set the name of the right is a clear-text field which uniquely which
211: * identifies what it is the group will be allowed to do. This name can
212: * include spaces.</p>
213: *
214: * @param nameParam clear text name of the right, possibly including spaces.
215: */
216: public final void setName(final String nameParam) {
217: if (logger.isDebugEnabled()) {
218: logger.debug("setName(String name = " + nameParam
219: + ") - start");
220: }
221:
222: this .name = nameParam;
223:
224: if (logger.isDebugEnabled()) {
225: logger.debug("setName(String) - end");
226: }
227: }
228: }
|