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.ServerRpc;
031
032/**
033 * Client-to-server rpc interface for the GWT dialog extension.<p>
034 */
035public interface I_CmsPropertyServerRpc extends ServerRpc {
036
037    /**
038     * Disposes of the extension, and tells the server which resources have changed.<p>
039     *
040     * @param delayMillis time to delay the RPC (for allowing short background operations to finish)
041     */
042    void onClose(long delayMillis);
043
044    /**
045     * Removes the extension on the server side.<p>
046     */
047    void removeExtension();
048
049    /**
050     * Requests the id of the next file.<p>
051     *
052     * @param offset should be +1 for the next file, or -1 for the previous file
053     */
054    void requestNextFile(int offset);
055
056    /**
057     * Saves the properties for a new resource.<p>
058     *
059     * @param data the serialized property data (CmsPropertyChangeSet)
060     */
061    void savePropertiesForNewResource(String data);
062}