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; 033 034/** 035 * Represents a repository.<p> 036 * 037 * Since different types of repositories have very different methods, this interface only 038 * provides the bare minimum of methods which are necessary for configuration.<p> 039 * 040 * @since 6.2.4 041 */ 042public interface I_CmsRepository extends I_CmsConfigurationParameterHandler { 043 044 /** 045 * Gets the repository filter.<p> 046 * 047 * @return the repository filter 048 */ 049 CmsRepositoryFilter getFilter(); 050 051 /** 052 * Returns the name of the repository.<p> 053 * 054 * @return the name of the repository 055 */ 056 String getName(); 057 058 /** 059 * Initializes this repository with an admin CMS object.<p> 060 * 061 * @param cms an admin CMS object 062 * @throws CmsException if something goes wrong 063 */ 064 void initializeCms(CmsObject cms) throws CmsException; 065 066 /** 067 * Sets the repository filter.<p> 068 * 069 * @param filter the repository filter 070 */ 071 void setFilter(CmsRepositoryFilter filter); 072 073 /** 074 * Sets the name for this repository.<p> 075 * 076 * @param name the name to use for the repository 077 */ 078 void setName(String name); 079}