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.setup;
029
030import org.opencms.module.CmsModuleVersion;
031
032/**
033 * Conveniently stores information necessary during the update.
034 */
035public class CmsUpdateInfo {
036
037    /** The single instance of this class. */
038    public static CmsUpdateInfo INSTANCE = new CmsUpdateInfo();
039
040    /** The containerpage editor version or null. */
041    private CmsModuleVersion m_adeModuleVersion;
042
043    /**
044     * Gets the container page editor version.<p>
045     *
046     * @return the module version
047     */
048    public CmsModuleVersion getAdeModuleVersion() {
049
050        return m_adeModuleVersion;
051    }
052
053    /**
054     * Checks if the categoryfolder setting needs to be updated.
055     *
056     * @return true if the categoryfolder setting needs to be updated
057     */
058    public boolean needToSetCategoryFolder() {
059
060        if (m_adeModuleVersion == null) {
061            return true;
062        }
063        CmsModuleVersion categoryFolderUpdateVersion = new CmsModuleVersion("9.0.0");
064        return (m_adeModuleVersion.compareTo(categoryFolderUpdateVersion) == -1);
065    }
066
067    /**
068     * Sets the container page editor version.<p>
069     *
070     * @param version the module version
071     */
072    public void setAdeModuleVersion(CmsModuleVersion version) {
073
074        m_adeModuleVersion = version;
075    }
076
077}