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.components;
029
030import java.util.List;
031
032import com.vaadin.shared.communication.ServerRpc;
033
034/**
035 * Client-to-server rpc interface for the GWT dialog extension.<p>
036 */
037public interface I_CmsGwtDialogServerRpc extends ServerRpc {
038
039    /**
040     *  Disposes of the extension and tells the server whether to re-init the UI.<p>
041     *
042     * @param reinitUI <code>true</code> to reinit the UI
043     */
044    void onClose(boolean reinitUI);
045
046    /**
047     * Disposes of the extension, and tells the server which resources have changed.<p>
048     *
049     * @param changedStructureIds the structure ids of changed resources, as strings
050     * @param delayMillis time to delay the RPC (for allowing short background operations to finish)
051     */
052    void onClose(List<String> changedStructureIds, long delayMillis);
053}