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.gwt.client.ui.contextmenu;
029
030import org.opencms.gwt.shared.CmsContextMenuEntryBean;
031import org.opencms.util.CmsUUID;
032
033/**
034 * Interface for context menu commands.<p>
035 *
036 * @since version 8.0.1
037 */
038public interface I_CmsContextMenuCommand {
039
040    /**
041     * Executed on context menu item click.<p>
042     *
043     * @param structureId the structure id of the resource
044     * @param handler the context menu handler
045     * @param bean the context menu entry bean
046     */
047    void execute(CmsUUID structureId, I_CmsContextMenuHandler handler, CmsContextMenuEntryBean bean);
048
049    /**
050     * Returns the special menu item widget for this command.<p>
051     *
052     * @param structureId the structure id of the resource
053     * @param handler the context menu handler
054     * @param bean the context menu entry bean
055     *
056     * @return the special menu item widget for this command
057     */
058    A_CmsContextMenuItem getItemWidget(
059        CmsUUID structureId,
060        I_CmsContextMenuHandler handler,
061        CmsContextMenuEntryBean bean);
062
063    /**
064     * Returns if this command provides it's own menu item widget.<p>
065     *
066     * @return <code>true</code> if this command provides it's own menu item widget
067     */
068    boolean hasItemWidget();
069}