001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.ade.postupload.shared.rpc;
029
030import org.opencms.ade.postupload.shared.CmsPostUploadDialogBean;
031import org.opencms.ade.postupload.shared.CmsPostUploadDialogPanelBean;
032import org.opencms.gwt.CmsRpcException;
033import org.opencms.util.CmsUUID;
034
035import com.google.gwt.user.client.rpc.RemoteService;
036
037/**
038 * Synchronous service interface for the upload property dialog.<p>
039 */
040public interface I_CmsPostUploadDialogService extends RemoteService {
041
042    /**
043     * Loads the dialog bean info for the given resource.<p>
044     *
045     * @param uuid structure id to get the dialog bean for
046     * @param useConfiguration true if the property configurations should be used
047     * @param addBasicProperties if true, the basic properties configured for the sitemap are added in the dialog
048     *
049     * @return the dialog bean info for the given resource
050     *
051     * @throws CmsRpcException if something goes wrong
052     */
053    CmsPostUploadDialogPanelBean load(CmsUUID uuid, boolean useConfiguration, boolean addBasicProperties)
054    throws CmsRpcException;
055
056    /**
057     * Generates dialog data for prefetching in the host page.<p>
058     *
059     * @return the dialog data
060     *
061     * @throws CmsRpcException if something goes wrong
062     */
063    CmsPostUploadDialogBean prefetch() throws CmsRpcException;
064
065}