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.repository;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.file.CmsObject;
032import org.opencms.main.CmsException;
033import org.opencms.util.CmsResourceTranslator;
034
035/**
036 * Represents a repository.<p>
037 *
038 * Since different types of repositories have very different methods, this interface only
039 * provides the bare minimum of methods which are necessary for configuration.<p>
040 *
041 * @since 6.2.4
042 */
043public interface I_CmsRepository extends I_CmsConfigurationParameterHandler {
044
045    /**
046     * Gets the repository filter.<p>
047     *
048     * @return the repository filter
049     */
050    CmsRepositoryFilter getFilter();
051
052    /**
053     * Returns the name of the repository.<p>
054     *
055     * @return the name of the repository
056     */
057    String getName();
058
059    /**
060     * Gets the repository-specific file translations.
061     *
062     * @return the repository-specific file translations
063     */
064    CmsResourceTranslator getTranslation();
065
066    /**
067     * Initializes this repository with an admin CMS object.<p>
068     *
069     * @param cms an admin CMS object
070     * @throws CmsException if something goes wrong
071     */
072    void initializeCms(CmsObject cms) throws CmsException;
073
074    /**
075     * Returns true if the repository specific file translations are enabled (they may also be set without being enabled).
076     *
077     * @return true if the file translations are enabled
078     */
079    boolean isTranslationEnabled();
080
081    /**
082     * Sets the repository filter.<p>
083     *
084     * @param filter the repository filter
085     */
086    void setFilter(CmsRepositoryFilter filter);
087
088    /**
089     * Sets the name for this repository.<p>
090     *
091     * @param name the name to use for the repository
092     */
093    void setName(String name);
094
095    /**
096     * Sets the repository-specific file translations
097     *
098     * @param translator the file translations
099     * @param enabled true if the translations should be enabled
100     */
101    void setTranslation(CmsResourceTranslator translator, boolean enabled);
102}