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: LibraryForm.java,v $
031: * Revision 1.3 2005/04/10 20:31:58 colinmacleod
032: * Added new themes.
033: * Changed id type to String.
034: * Changed i tag to em and b tag to strong.
035: * Improved PicoContainerFactory with NanoContainer scripts.
036: *
037: * Revision 1.2 2005/04/09 17:19:46 colinmacleod
038: * Changed copyright text to GPL v2 explicitly.
039: *
040: * Revision 1.1.1.1 2005/03/10 17:52:01 colinmacleod
041: * Restructured ivata op around Hibernate/PicoContainer.
042: * Renamed ivata groupware.
043: *
044: * Revision 1.4 2004/11/12 18:19:15 colinmacleod
045: * Change action and form classes to extend MaskAction, MaskForm respectively.
046: *
047: * Revision 1.3 2004/03/21 21:16:29 colinmacleod
048: * Shortened name to ivata op.
049: *
050: * Revision 1.2 2004/02/01 22:07:31 colinmacleod
051: * Added full names to author tags
052: *
053: * Revision 1.1.1.1 2004/01/27 20:58:41 colinmacleod
054: * Moved ivata openportal to SourceForge..
055: *
056: * Revision 1.2 2003/10/15 14:16:53 colin
057: * fixing for XDoclet
058: *
059: * Revision 1.2 2003/02/28 07:30:22 colin
060: * implemented editing/displaying of faqs & notes
061: * Revision 1.1 2003/02/24 19:09:24 colin
062: * moved to business
063: * -----------------------------------------------------------------------------
064: */
065: package com.ivata.groupware.business.library.struts;
066:
067: import com.ivata.mask.Mask;
068: import com.ivata.mask.web.struts.DialogForm;
069:
070: /**
071: * <p>Provides a base class for library form
072: * classes, to retrieve the library objects.</p>
073: *
074: *
075: * @since 2003-02-18
076: * @author Colin MacLeod
077: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
078: * @version $Revision: 1.3 $
079: */
080: public abstract class LibraryForm extends DialogForm {
081:
082: /**
083: * <p>Indicates the current item/comment should be edited.</p>
084: */
085: private String edit = null;
086: /**
087: * <p>When submitting library items and comments, they must be
088: * previewed once before submitting.</p>
089: */
090: private String preview = null;
091: /**
092: * <p>
093: * Defines the base class of all objects in the value object list.
094: * </p>
095: */
096: private Class baseClass;
097: /**
098: * <p>
099: * Mask containing all the field definitions for this list.
100: * </p>
101: */
102: private Mask mask;
103:
104: /**
105: * <p>Default constructor. Overridden to set <code>bundle</code>.</p>
106: *
107: * @param maskParam
108: * Refer to {@link #getMask}.
109: * @param baseClassParam
110: * Refer to {@link #getBaseClass}.
111: */
112: public LibraryForm() {
113: // we want messages from the library
114: setBundle("library");
115: }
116:
117: /**
118: * <p>Indicates the current item/comment should be edited.</p>
119: *
120: * @return the current value of edit.
121: */
122: public final String getEdit() {
123: return edit;
124: }
125:
126: /**
127: * <p>When submitting library items and comments, they must be
128: * previewed once before submitting.</p>
129: *
130: * @return the current value of preview.
131: */
132: public final String getPreview() {
133: return preview;
134: }
135:
136: /**
137: * <p>Indicates the current item/comment should be edited.</p>
138: *
139: * @param edit the new value of edit.
140: */
141: public final void setEdit(final String edit) {
142: this .edit = edit;
143: }
144:
145: /**
146: * <p>When submitting library items and comments, they must be
147: * previewed once before submitting.</p>
148: *
149: * @param preview the new value of preview.
150: */
151: public final void setPreview(final String preview) {
152: this .preview = preview;
153: }
154:
155: /**
156: * <p>
157: * Defines the base class of all objects in the value object list.
158: * </p>
159: *
160: * @return base class of all objects in the value object list.
161: */
162: public final Class getBaseClass() {
163: return baseClass;
164: }
165:
166: /**
167: * <p>
168: * Mask containing all the field definitions for this list.
169: * </p>
170: *
171: * @return mask containing all the field definitions for this list.
172: */
173: public final Mask getMask() {
174: return mask;
175: }
176: }
|