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.shared.rpc;
029
030import com.vaadin.shared.communication.ClientRpc;
031
032/**
033 * Interface for the server-to-client RPC calls used by the sitemap extension.<p>
034 *
035 */
036public interface I_CmsSitemapClientRpc extends ClientRpc {
037
038    /**
039     * Signals to the client that the page copy dialog has finished.<p>
040     *
041     * @param callId the call id which was initially used to open the dialog
042     * @param response a string representing the result code of the page copy dialog
043     */
044    void finishPageCopyDialog(String callId, String response);
045
046    /**
047     * Opens the property dialog in the locale comparison view.<p>
048     *
049     * @param structureId the structure id of the resource for which to open the property dialog
050     * @param rootId the root structure id of the locale comparison tree
051     */
052    void openPropertyDialog(String structureId, String rootId);
053
054    /**
055     * Displays the header for a sub-sitemap in the locale comparison view.<p>
056     *
057     * @param title the title
058     * @param description the description
059     * @param path the path
060     * @param locale the locale
061     * @param icon the CSS classes for the icon
062     */
063    void showInfoHeader(String title, String description, String path, String locale, String icon);
064
065}