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.relations;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032
033/**
034 * Interface used to inject custom link handling behavior into HTML/link content fields.
035 */
036public interface I_CmsCustomLinkRenderer {
037
038    /**
039     * Returns the link for the given link object.<p>
040     *
041     * If null is returned, this means the normal link handling behavior should be used instead.
042     *
043     * @param cms the CMS context
044     * @param link the link object
045     *
046     * @return the link for the link object
047     */
048    String getLink(CmsObject cms, CmsLink link);
049
050    /**
051     * Returns the link for the given link resource.<p>
052     *
053     * If null is returned, this means the normal link handling behavior should be used instead.
054     *
055     * @param cms the CMS context
056     * @param resource the resource linked to
057     *
058     * @return the link for the link object
059     */
060    String getLink(CmsObject cms, CmsResource resource);
061
062}