org.opencms.ade.detailpage.I_CmsDetailPageFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ade.detailpage;

import org.opencms.file.CmsObject;
import org.opencms.main.CmsException;

import java.util.Collection;

/**
 * Interface for classes which can find the detail page for a given resource.
 *
 * @since 8.0.0
 */
public interface I_CmsDetailPageFinder {

    /**
     * Finds all detail pages for a given resource.

     *
     * @param cms the current CMS context
     * @param restype the resource type for which the detail pages should be found
     *
     * @return the list of detail page
     *
     * @throws CmsException in case reading the resource type fails
     */
    Collection getAllDetailPages(CmsObject cms, int restype) throws CmsException;

    /**
     * Returns the detail page link for the given resource, or null if there is no detail page for the resource.
     *
     * @param cms the CMS context
     * @param rootPath the root path of the resource for which the detail page should be looked up
     * @param linkSource the uri in the context of which the detail page link is being generated (relative to the site)
     * @param targetDetailPage the target detail page to use
     *
     * @return the detail page link, or null
     *
     * @throws CmsException if something goes wrong
     */
    String getDetailPage(CmsObject cms, String rootPath, String linkSource, String targetDetailPage)
    throws CmsException;

}