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.ade.publish;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.main.CmsException;
033
034import java.util.Set;
035
036/**
037 * Interface used to generate mode-specific 'related resources' for the publish dialog in addition to resources linked by normal relations.<p>
038 */
039public interface I_CmsPublishRelatedResourceProvider {
040
041    /**
042     * Gets the set of additional related resources.<p>
043     *
044     * @param cms the current CMS context
045     * @param res the resource for which the related resources should be returned
046     *
047     * @return the set of related resources
048     *
049     * @throws CmsException if something goes wrong
050     */
051    Set<CmsResource> getAdditionalRelatedResources(CmsObject cms, CmsResource res) throws CmsException;
052
053}