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.ui.sitemap;
029
030import org.opencms.file.CmsResource;
031import org.opencms.i18n.CmsLocaleGroup;
032
033import java.util.Locale;
034
035/**
036 * Provides information about the current state of the locale comparison editor.<p>
037 */
038public interface I_CmsLocaleCompareContext {
039
040    /**
041     * Gets the comparison locale.<p>
042     *
043     * @return the comparison locale
044     */
045    Locale getComparisonLocale();
046
047    /**
048     * Gets the locale group of the root resource.
049     *
050     * @return the locale group of the root resource
051     */
052    CmsLocaleGroup getLocaleGroup();
053
054    /**
055     * Gets the root resource.<p>
056     *
057     * @return the root resource
058     */
059    CmsResource getRoot();
060
061    /**
062     * Gets the root locale.<p>
063     *
064     * @return the root locale
065     */
066    Locale getRootLocale();
067
068    /**
069     * Refreshes everything.
070     */
071    void refreshAll();
072
073}