001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 * Contributors:
016 * Nuxeo - initial API and implementation
017 */
018
019package org.nuxeo.theme.localconfiguration;
020
021import org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration;
022
023/**
024 * Local configuration class to handle configuration of theme.
025 *
026 * @author <a href="mailto:qlamerand@nuxeo.com">Quentin Lamerand</a>
027 */
028public interface LocalThemeConfig extends LocalConfiguration<LocalThemeConfig> {
029
030    public static final String OLD_THEME_CONFIGURATION_PROPERTY = "theme.useOldLocalConfiguration";
031
032    /**
033     * Returns the configured theme.
034     */
035    @Deprecated
036    String getTheme();
037
038    /**
039     * Returns the configured page for the selected theme.
040     */
041    @Deprecated
042    String getPage();
043
044    /**
045     * Returns the configured perspective used in the {@code LocalPerspective} negociation scheme.
046     */
047    @Deprecated
048    String getPerspective();
049
050    /**
051     * Returns the configured engine.
052     */
053    @Deprecated
054    String getEngine();
055
056    /**
057     * Returns the configured mode.
058     */
059    @Deprecated
060    String getMode();
061
062    /**
063     * Returns the page path used in the {@code LocalTheme} negotiation scheme
064     */
065    @Deprecated
066    String computePagePath();
067
068    /**
069     * Returns the flavor (collection) to use for current page
070     *
071     * @since 5.5
072     */
073    String getFlavor();
074
075}