001/*
002 * (C) Copyright 2011 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 * Contributors:
014 * Nuxeo - initial API and implementation
015 */
016
017package org.nuxeo.theme.localconfiguration;
018
019import org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration;
020
021/**
022 * Local configuration class to handle configuration of theme.
023 *
024 * @author <a href="mailto:qlamerand@nuxeo.com">Quentin Lamerand</a>
025 */
026public interface LocalThemeConfig extends LocalConfiguration<LocalThemeConfig> {
027
028    public static final String OLD_THEME_CONFIGURATION_PROPERTY = "theme.useOldLocalConfiguration";
029
030    /**
031     * Returns the configured theme.
032     */
033    @Deprecated
034    String getTheme();
035
036    /**
037     * Returns the configured page for the selected theme.
038     */
039    @Deprecated
040    String getPage();
041
042    /**
043     * Returns the configured perspective used in the {@code LocalPerspective} negociation scheme.
044     */
045    @Deprecated
046    String getPerspective();
047
048    /**
049     * Returns the configured engine.
050     */
051    @Deprecated
052    String getEngine();
053
054    /**
055     * Returns the configured mode.
056     */
057    @Deprecated
058    String getMode();
059
060    /**
061     * Returns the page path used in the {@code LocalTheme} negotiation scheme
062     */
063    @Deprecated
064    String computePagePath();
065
066    /**
067     * Returns the flavor (collection) to use for current page
068     *
069     * @since 5.5
070     */
071    String getFlavor();
072
073}