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.detailpage;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.file.CmsObject;
032import org.opencms.file.CmsResource;
033import org.opencms.main.CmsException;
034
035import java.util.Collection;
036
037/**
038 * Interface for classes which can find the detail page for a given resource,
039 * and determine whether a given detail page / detail content combination is valid.
040 *
041 * @since 8.0.0
042 */
043public interface I_CmsDetailPageHandler extends I_CmsConfigurationParameterHandler {
044
045    /**
046     * Checks whether the given detail page is valid for the given resource.<p>
047     *
048     * @param cms the CMS context
049     * @param page the detail page
050     * @param detailRes the detail resource
051     *
052     * @return true if the given detail page is valid
053     */
054    public boolean isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes);
055
056    /**
057     * Finds all detail pages for a given resource.<p>
058     *
059     * @param cms the current CMS context
060     * @param restype the resource type for which the detail pages should be found
061     *
062     * @return the list of detail page
063     *
064     * @throws CmsException in case reading the resource type fails
065     */
066    Collection<String> getAllDetailPages(CmsObject cms, int restype) throws CmsException;
067
068    /**
069     * Returns the detail page link for the given resource, or null if there is no detail page for the resource.<p>
070     *
071     * @param cms the CMS context
072     * @param rootPath the root path of the resource for which the detail page should be looked up
073     * @param linkSource the uri in the context of which the detail page link is being generated (relative to the site)
074     * @param targetDetailPage the target detail page to use
075     *
076     * @return the detail page link, or null
077     */
078    String getDetailPage(CmsObject cms, String rootPath, String linkSource, String targetDetailPage);
079
080    /**
081     * Initializes the detail page handler.
082     *
083     * @param offlineCms offline CMS context
084     * @param onlineCms online CMS context
085     */
086    void initialize(CmsObject offlineCms, CmsObject onlineCms);
087
088}