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 * Client RPC to handle embedded dialogs.<p>
034 */
035public interface I_CmsEmbeddedDialogClientRPC extends ClientRpc {
036
037    /**
038     * Removes the dialog iFrame and refreshes the given resources.<p>
039     *
040     * @param resourceIds the resources to refresh
041     */
042    void finish(String resourceIds);
043
044    /**
045     * Removes the dialog iFrame and reloads the app for the given site path and server link.<p>
046     *
047     * @param sitePath the site path
048     * @param serverLink the server link
049     */
050    void finishForProjectOrSiteChange(String sitePath, String serverLink);
051
052    /**
053     * Tells the client to initialize the client-to-server RPC.
054     **/
055    void initServerRpc();
056
057    /**
058     * Leaves the current page calling the given URI.<p>
059     *
060     * @param targetUri the target URI
061     */
062    void leavePage(String targetUri);
063
064    /**
065     * Reloads the parent window.<p>
066     */
067    void reloadParent();
068
069    /**
070     * Sets the selected string.<p>
071     *
072     * @param str the string
073     */
074    void selectString(String str);
075}