I_CmsDialogHandler.java

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (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 GmbH, 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.workplace;

import org.opencms.configuration.I_CmsConfigurationParameterHandler;
import org.opencms.jsp.CmsJspActionElement;

/**
 * Provides a method for selecting an individual jsp dialog.<p>
 * 
 * You can define the class of your own dialog handler in the OpenCms opencms-workplace.xml
 * changing the <class> attribute of the node <dialoghandler> to another value. 
 * The class you enter must implement this interface to obtain the URI of the displayed dialog.<p>  
 * 
 * @since 6.0.0 
 */
public interface I_CmsDialogHandler extends I_CmsConfigurationParameterHandler {

    /**
     * Returns the name of the handler which is used as key for the OpenCms runtime properties.<p>
     * 
     * Store the name of the key as a public String constant in the CmsDialogSelector class.<p>
     * 
     * @return the name of the dialog handler
     */
    String getDialogHandler();

    /**
     * Returns the dialog URI in the OpenCms VFS to the dialog selector class.<p>
     * 
     * @param resource the selected resource
     * @param jsp the CmsJspActionElement
     * @return the absolute path to the property dialog
     */
    String getDialogUri(String resource, CmsJspActionElement jsp);

}