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.workplace;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.jsp.CmsJspActionElement;
032
033/**
034 * Provides a method for selecting an individual jsp dialog.<p>
035 *
036 * You can define the class of your own dialog handler in the OpenCms opencms-workplace.xml
037 * changing the &lt;class&gt; attribute of the node &lt;dialoghandler&gt; to another value.
038 * The class you enter must implement this interface to obtain the URI of the displayed dialog.<p>
039 *
040 * @since 6.0.0
041 */
042public interface I_CmsDialogHandler extends I_CmsConfigurationParameterHandler {
043
044    /**
045     * Returns the name of the handler which is used as key for the OpenCms runtime properties.<p>
046     *
047     * Store the name of the key as a public String constant in the CmsDialogSelector class.<p>
048     *
049     * @return the name of the dialog handler
050     */
051    String getDialogHandler();
052
053    /**
054     * Returns the dialog URI in the OpenCms VFS to the dialog selector class.<p>
055     *
056     * @param resource the selected resource
057     * @param jsp the CmsJspActionElement
058     * @return the absolute path to the property dialog
059     */
060    String getDialogUri(String resource, CmsJspActionElement jsp);
061
062}