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.client.ui.contenteditor.I_CmsContentEditorHandler;
031import org.opencms.gwt.client.util.I_CmsSimpleCallback;
032import org.opencms.util.CmsUUID;
033
034import java.util.Map;
035
036/**
037 * Interface for context menu commands.<p>
038 *
039 * @since version 8.0.1
040 */
041public interface I_CmsContextMenuHandler extends I_CmsActionHandler {
042
043    /**
044     * Tries to lock the given resource and returns <code>true</code> on success.
045     * If not successful a warning should be displayed.<p>
046     *
047     * @param structureId the structure id of the resource to lock
048     * @param callback the callback to execute
049     */
050    void ensureLockOnResource(CmsUUID structureId, I_CmsSimpleCallback<Boolean> callback);
051
052    /**
053     * Returns the available context menu commands as a map by class name.<p>
054     *
055     * @return the available context menu commands as a map by class name
056     */
057    Map<String, I_CmsContextMenuCommand> getContextMenuCommands();
058
059    /**
060     * Returns the context type.<p>
061     *
062     * @return the context type
063     */
064    String getContextType();
065
066    /**
067     * Returns the editor handler.<p>
068     *
069     * @return the editor handler
070     */
071    I_CmsContentEditorHandler getEditorHandler();
072
073    /**
074     * Unlocks the resource if appropriate.<p>
075     *
076     * @param structureId the structure id of the resource to lock
077     */
078    void unlockResource(CmsUUID structureId);
079}