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.ui.actions;
029
030import java.util.Map;
031
032/**
033 * Interface for actions used within the ADE context.<p>
034 */
035public interface I_CmsADEAction {
036
037    /**
038     * Returns the client side command to execute.<p>
039     *
040     * @return the client side command
041     */
042    String getCommandClassName();
043
044    /**
045     * Returns the optional dialog JSP.<p>
046     *
047     * @return the dialog JSP
048     */
049    String getJspPath();
050
051    /**
052     * Returns the optional command parameters.<p>
053     *
054     * @return the command parameters
055     */
056    Map<String, String> getParams();
057
058    /**
059     * Returns whether the ADE context is supported.<p>
060     *
061     * @return <code>true</code> in case the ADE context is supported
062     */
063    boolean isAdeSupported();
064}