001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.tools.modules;
029
030/**
031 * Clone module information bean.<p>
032 */
033public class CmsCloneModuleInfo {
034
035    /** The action class used for the clone. */
036    private String m_actionClass;
037
038    /** If 'true' resource types in all sites will be adjusted. */
039    private String m_applyChangesEverywhere;
040
041    /** The author's email used for the clone. */
042    private String m_authorEmail = "sales@alkacon.com";
043
044    /** The author's name used for the clone. */
045    private String m_authorName = "Alkacon Software GmbH & Co. KG";
046
047    /** Option to change the resource types (optional flag). */
048    private String m_changeResourceTypes;
049
050    /** The description used for the clone. */
051    private String m_description = "This module provides the template layout.";
052
053    /** A module name where the formatters are located that are referenced within the XSDs of the module to clone. */
054    private String m_formatterSourceModule = "com.alkacon.bootstrap.formatters";
055
056    /** A module name where the formatters are located that should be referenced by the XSDs of the clone. */
057    private String m_formatterTargetModule;
058
059    /** The module group used for the clone. */
060    private String m_group;
061
062    /** The new module name used for the clone. */
063    private String m_name = "my.company.template";
064
065    /** The nice name used for the clone. */
066    private String m_niceName = "My new template module.";
067
068    /** Flag that controls whether container pages should be rewritten. */
069    private boolean m_rewriteContainerPages;
070
071    /** The name of the source module to be cloned. */
072    private String m_sourceModuleName = "com.alkacon.bootstrap.formatters";
073
074    /** The prefix that is used by the source module. */
075    private String m_sourceNamePrefix = "bs-";
076
077    /** The prefix that is used by the target module. */
078    private String m_targetNamePrefix = "my-";
079
080    /**
081     * Returns the action class.<p>
082     *
083     * @return the action class
084     */
085    public String getActionClass() {
086
087        return m_actionClass;
088    }
089
090    /**
091     * Returns the changeResourceTypesEverywhere.<p>
092     *
093     * @return the changeResourceTypesEverywhere
094     */
095    public String getApplyChangesEverywhere() {
096
097        return m_applyChangesEverywhere;
098    }
099
100    /**
101     * Returns the author email.<p>
102     *
103     * @return the author email
104     */
105    public String getAuthorEmail() {
106
107        return m_authorEmail;
108    }
109
110    /**
111     * Returns the author name.<p>
112     *
113     * @return the author name
114     */
115    public String getAuthorName() {
116
117        return m_authorName;
118    }
119
120    /**
121     * Returns the change resource types flag as String.<p>
122     *
123     * @return the change resource types flag as String
124     */
125    public String getChangeResourceTypes() {
126
127        return m_changeResourceTypes;
128    }
129
130    /**
131     * Returns the description.<p>
132     *
133     * @return the description
134     */
135    public String getDescription() {
136
137        return m_description;
138    }
139
140    /**
141     * Returns the formatter source module package/name.<p>
142     *
143     * @return the formatter source module package/name
144     */
145    public String getFormatterSourceModule() {
146
147        return m_formatterSourceModule;
148    }
149
150    /**
151     * Returns the formatter target module package/name.<p>
152     *
153     * @return the formatter target module package/name
154     */
155    public String getFormatterTargetModule() {
156
157        return m_formatterTargetModule;
158    }
159
160    /**
161     * Returns the group.<p>
162     *
163     * @return the group
164     */
165    public String getGroup() {
166
167        return m_group;
168    }
169
170    /**
171     * Returns the package/module name for the clone/target.<p>
172     *
173     * @return the package/module name for the clone/target
174     */
175    public String getName() {
176
177        return m_name;
178    }
179
180    /**
181     * Returns the nice name.<p>
182     *
183     * @return the nice name
184     */
185    public String getNiceName() {
186
187        return m_niceName;
188    }
189
190    /**
191     * Returns the source module package/name (the module to clone).<p>
192     *
193     * @return the source module package/name (the module to clone)
194     */
195    public String getSourceModuleName() {
196
197        return m_sourceModuleName;
198    }
199
200    /**
201     * Returns the source name prefix.<p>
202     *
203     * @return the source name prefix
204     */
205    public String getSourceNamePrefix() {
206
207        return m_sourceNamePrefix;
208    }
209
210    /**
211     * Returns the target name prefix.<p>
212     *
213     * @return the target name prefix
214     */
215    public String getTargetNamePrefix() {
216
217        return m_targetNamePrefix;
218    }
219
220    /**
221     * Returns the rewriteContainerPages.<p>
222     *
223     * @return the rewriteContainerPages
224     */
225    public boolean isRewriteContainerPages() {
226
227        return m_rewriteContainerPages;
228    }
229
230    /**
231     * Sets the action class.<p>
232     *
233     * @param actionClass the action class
234     */
235    public void setActionClass(String actionClass) {
236
237        m_actionClass = actionClass;
238    }
239
240    /**
241     * Sets the changeResourceTypesEverywhere.<p>
242     *
243     * @param applyChangesEverywhere the changeResourceTypesEverywhere to set
244     */
245    public void setApplyChangesEverywhere(String applyChangesEverywhere) {
246
247        m_applyChangesEverywhere = applyChangesEverywhere;
248    }
249
250    /**
251     * Sets the author email.<p>
252     *
253     * @param authorEmail the author email to set
254     */
255    public void setAuthorEmail(String authorEmail) {
256
257        m_authorEmail = authorEmail;
258    }
259
260    /**
261     * Sets the author name.<p>
262     *
263     * @param authorName the author name to set
264     */
265    public void setAuthorName(String authorName) {
266
267        m_authorName = authorName;
268    }
269
270    /**
271     * Sets the change resource types flag.<p>
272     *
273     * @param changeResourceTypes the change resource types falg to set
274     */
275    public void setChangeResourceTypes(String changeResourceTypes) {
276
277        m_changeResourceTypes = changeResourceTypes;
278    }
279
280    /**
281     * Sets the description.<p>
282     *
283     * @param description the description to set
284     */
285    public void setDescription(String description) {
286
287        m_description = description;
288    }
289
290    /**
291     * Sets the formatter source module name.<p>
292     *
293     * @param formatterSourceModule the formatter source module name to set
294     */
295    public void setFormatterSourceModule(String formatterSourceModule) {
296
297        m_formatterSourceModule = formatterSourceModule;
298    }
299
300    /**
301     * Sets the formatter target module name.<p>
302     *
303     * @param formatterTargetModule the formatter target module name to set
304     */
305    public void setFormatterTargetModule(String formatterTargetModule) {
306
307        m_formatterTargetModule = formatterTargetModule;
308    }
309
310    /**
311     * Sets the group.<p>
312     *
313     * @param group the group to set
314     */
315    public void setGroup(String group) {
316
317        m_group = group;
318    }
319
320    /**
321     * Sets the module package name.<p>
322     *
323     * @param name the module package name to set
324     */
325    public void setName(String name) {
326
327        m_name = name;
328    }
329
330    /**
331     * Sets the nice name.<p>
332     *
333     * @param niceName the nice name to set
334     */
335    public void setNiceName(String niceName) {
336
337        m_niceName = niceName;
338    }
339
340    /**
341     * Sets the rewriteContainerPages.<p>
342     *
343     * @param rewriteContainerPages the rewriteContainerPages to set
344     */
345    public void setRewriteContainerPages(boolean rewriteContainerPages) {
346
347        m_rewriteContainerPages = rewriteContainerPages;
348    }
349
350    /**
351     * Sets the source module name.<p>
352     *
353     * @param sourceModuleName the source module name to set
354     */
355    public void setSourceModuleName(String sourceModuleName) {
356
357        m_sourceModuleName = sourceModuleName;
358    }
359
360    /**
361     * Sets the source name prefix.<p>
362     *
363     * @param sourceNamePrefix the source name prefix to set
364     */
365    public void setSourceNamePrefix(String sourceNamePrefix) {
366
367        m_sourceNamePrefix = sourceNamePrefix;
368    }
369
370    /**
371     * Sets the target name prefix.<p>
372     *
373     * @param targetNamePrefix the target name prefix to set
374     */
375    public void setTargetNamePrefix(String targetNamePrefix) {
376
377        m_targetNamePrefix = targetNamePrefix;
378    }
379}