KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ivata > groupware > business > library > page > PageDO


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: PageDO.java,v $
31  * Revision 1.3 2005/04/10 20:09:45 colinmacleod
32  * Added new themes.
33  * Changed id type to String.
34  * Changed i tag to em and b tag to strong.
35  * Improved PicoContainerFactory with NanoContainer scripts.
36  *
37  * Revision 1.2 2005/04/09 17:19:45 colinmacleod
38  * Changed copyright text to GPL v2 explicitly.
39  *
40  * Revision 1.1.1.1 2005/03/10 17:51:59 colinmacleod
41  * Restructured ivata op around Hibernate/PicoContainer.
42  * Renamed ivata groupware.
43  *
44  * Revision 1.1 2004/07/13 19:47:29 colinmacleod
45  * Moved project to POJOs from EJBs.
46  * Applied PicoContainer to services layer (replacing session EJBs).
47  * Applied Hibernate to persistence layer (replacing entity EJBs).
48  *
49  * Revision 1.3 2004/03/21 21:16:29 colinmacleod
50  * Shortened name to ivata op.
51  *
52  * Revision 1.2 2004/02/01 22:07:31 colinmacleod
53  * Added full names to author tags
54  *
55  * Revision 1.1.1.1 2004/01/27 20:58:40 colinmacleod
56  * Moved ivata openportal to SourceForge..
57  *
58  * Revision 1.5 2003/11/03 11:29:44 jano
59  * commiting library,
60  * tryinjg to fix deploying problem
61  *
62  * Revision 1.4 2003/10/28 13:16:14 jano
63  * commiting library,
64  * still fixing compile and building openGroupware project
65  *
66  * Revision 1.3 2003/10/15 14:21:49 jano
67  * converting to XDoclet
68  *
69  * Revision 1.2 2003/10/15 14:16:53 colin
70  * fixing for XDoclet
71  *
72  * Revision 1.3 2003/05/01 12:13:22 jano
73  * tidy up names of sequeneces
74  *
75  * Revision 1.2 2003/02/25 14:38:13 colin
76  * implemented setModified methods on entity beans thro IvataEntityBean superclass
77  *
78  * Revision 1.1 2003/02/24 19:09:22 colin
79  * moved to business
80  *
81  * Revision 1.5 2003/02/04 17:43:47 colin
82  * copyright notice
83  *
84  * Revision 1.4 2002/08/11 11:35:07 colin
85  * cosmetic changes
86  *
87  * Revision 1.3 2002/07/04 12:29:28 jano
88  * i put readonly script to CVS and i will commit all SRC directory
89  *
90  * Revision 1.2 2002/07/02 14:56:55 colin
91  * tried to fix jbuilder EJB designer
92  *
93  * Revision 1.1 2002/06/18 11:40:13 colin
94  * first version of library
95  * -----------------------------------------------------------------------------
96  */
97 package com.ivata.groupware.business.library.page;
98
99 import com.ivata.groupware.container.persistence.BaseDO;
100
101
102 /**
103  * <p>Represents a page of text within the library. Items with the following
104  * types can have pages associated with them:<br/>
105  * <ul>
106  * <li>document</li>
107  * <li>memo</li>
108  * <li>news item</li>
109  * <li>meeting agenda/minutes</li>
110  * </ul></p>
111  *
112  * @since 2002-06-14
113  * @author Colin MacLeod
114  * <a HREF='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
115  * @version $Revision: 1.3 $
116  *
117  * @hibernate.class
118  * table="library_page"
119  */
120 public class PageDO extends BaseDO {
121
122     /**
123      * <p>Get the page number of this page within the library item. The first
124      * page in the item will have the number <code>0</code>.</p>
125      *
126      * @return an <code>Integer</code> beginning with 0 describing the
127      * page's significance within it's library item. Lower numbers have higher
128      * significance.
129      */
130     private Integer JavaDoc number;
131
132     /**
133      * <p>
134      * Contains the contents of the page.
135      * </p>
136      */
137     private String JavaDoc text;
138
139     /**
140      * <p>Get the page number of this page within the library item. The first
141      * page in the item will have the number <code>0</code>.</p>
142      *
143      * @return an <code>Integer</code> beginning with 0 describing the
144      * page's significance within it's library item. Lower numbers have higher
145      * significance.
146      * @hibernate.property
147      */
148     public final Integer JavaDoc getNumber() {
149         return number;
150     }
151     /**
152      * <p>
153      * Contains the contents of the page.
154      * </p>
155      *
156      * @return Human-readable, clear text contents of the page.
157      * @hibernate.property
158      */
159     public final String JavaDoc getText() {
160         return text;
161     }
162     /**
163      * <p>Set the page number of this page within the library item. The first
164      * page in the item will have the number <code>0</code>.</p>
165      *
166      * @param number An <code>Integer</code> beginning with 0 describing the
167      * page's significance within it's library item. Lower numbers have higher
168      * significance.
169      */
170     public final void setNumber(final Integer JavaDoc number) {
171         this.number = number;
172     }
173     /**
174      * <p>
175      * Contains the contents of the page.
176      * </p>
177      *
178      * @param text Human-readable, clear text contents of the page.
179      */
180     public final void setText(final String JavaDoc text) {
181         this.text = text;
182     }
183 }
184
Popular Tags