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 * Server-to-client Interface for the GWT dialog extension.<p>
034 */
035public interface I_CmsPropertyClientRpc extends ClientRpc {
036
037    /**
038     * Send a confirmation to the client that the properties for a new resource have been saved.<p>
039     */
040    void confirmSaveForNew();
041
042    /**
043     * Tells the client to open the property editing dialog for the resource with the given structure id.<p>
044     *
045     * @param structureId the structure id of a resource, as a string
046     * @param editName if true, makes the file name editable
047     * @param disablePrevNext if true, disables the prev/next button
048     */
049    void editProperties(String structureId, boolean editName, boolean disablePrevNext);
050
051    /**
052     * Opens the property editor for a new resource.<p>
053     *
054     * @param propertyData the property data serialized using GWT serialization
055     */
056    void editPropertiesForNewResource(String propertyData);
057
058    /**
059     * Sends next structure id to the client.<p>
060     *
061     * @param id the next structure id
062     */
063    void sendNextId(String id);
064
065}