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 GmbH & Co. KG, 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.content;
029
030/**
031 * Settings object that provides the settings to convert page locales from one locale to another.<p>
032 *
033 * @since 6.0.1
034 */
035public class CmsElementChangeLocaleSettings {
036
037    /** Flag indicating if resources in sub folders should be changed, too. */
038    private boolean m_includeSubFolders;
039
040    /** The new Locale to use for the page elements. */
041    private String m_newLocale;
042
043    /** The old Locale of the page elements. */
044    private String m_oldLocale;
045
046    /** The template for the pages that should be converted. */
047    private String m_template;
048
049    /** The VFS folder in OpenCms to start the conversion from. */
050    private String m_vfsFolder;
051
052    /**
053     * Default constructor.<p>
054     */
055    public CmsElementChangeLocaleSettings() {
056
057        super();
058    }
059
060    /**
061     * Returns the new Locale to use for the page elements.<p>
062     *
063     * @return the new Locale to use for the page elements
064     */
065    public String getNewLocale() {
066
067        return m_newLocale;
068    }
069
070    /**
071     * Returns the old Locale of the page elements.<p>
072     *
073     * @return the old Locale of the page elements
074     */
075    public String getOldLocale() {
076
077        return m_oldLocale;
078    }
079
080    /**
081     * Returns the template for the pages that should be converted.<p>
082     *
083     * @return the template for the pages that should be converted
084     */
085    public String getTemplate() {
086
087        return m_template;
088    }
089
090    /**
091     * Returns the VFS folder in OpenCms to start the conversion from.<p>
092     *
093     * @return the VFS folder in OpenCms to start the conversion from
094     */
095    public String getVfsFolder() {
096
097        return m_vfsFolder;
098    }
099
100    /**
101     * Returns the flag indicating if resources in sub folders should be changed, too.<p>
102     *
103     * @return the flag indicating if resources in sub folders should be changed, too
104     */
105    public boolean isIncludeSubFolders() {
106
107        return m_includeSubFolders;
108    }
109
110    /**
111     * Sets the flag indicating if resources in sub folders should be changed, too.<p>
112     *
113     * @param includeSubFolders the flag indicating if resources in sub folders should be changed, too
114     */
115    public void setIncludeSubFolders(boolean includeSubFolders) {
116
117        m_includeSubFolders = includeSubFolders;
118    }
119
120    /**
121     * Sets the new Locale to use for the page elements.<p>
122     *
123     * @param newLocale the new Locale to use for the page elements
124     */
125    public void setNewLocale(String newLocale) {
126
127        m_newLocale = newLocale;
128    }
129
130    /**
131     * Sets the old Locale of the page elements.<p>
132     *
133     * @param oldLocale the old Locale of the page elements
134     */
135    public void setOldLocale(String oldLocale) {
136
137        m_oldLocale = oldLocale;
138    }
139
140    /**
141     * Sets the template for the pages that should be converted.<p>
142     *
143     * @param template the template for the pages that should be converted
144     */
145    public void setTemplate(String template) {
146
147        m_template = template;
148    }
149
150    /**
151     * Sets the VFS folder in OpenCms to start the conversion from.<p>
152     *
153     * @param vfsFolder the VFS folder in OpenCms to start the conversion from
154     */
155    public void setVfsFolder(String vfsFolder) {
156
157        m_vfsFolder = vfsFolder;
158    }
159
160}