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.gwt.shared;
029
030import java.util.List;
031import java.util.Map;
032
033/**
034 * AutoBean interface for the data needed to open an embedded Vaadin dialog from GWT.
035 */
036public interface I_CmsEmbeddedDialogInfo {
037
038    /**
039     * Gets the context type.
040     *
041     * @return the context type
042     */
043    public String getContextType();
044
045    /**
046     * Gets the dialog id.
047     *
048     * @return the dialog id
049     */
050    public String getDialogId();
051
052    /**
053     * Gets the parameters.
054     *
055     * @return the parameters
056     */
057    public Map<String, String> getParameters();
058
059    /**
060     * Gets the structure ids.
061     *
062     * @return the structure ids
063     */
064    public List<String> getStructureIds();
065
066    /**
067     * Sets the context type.
068     *
069     * @param contextType the new context type
070     */
071    public void setContextType(String contextType);
072
073    /**
074     * Sets the dialog id.
075     *
076     * @param dialogId the new dialog id
077     */
078    public void setDialogId(String dialogId);
079
080    /**
081     * Sets the parameters.
082     *
083     * @param parameters the parameters
084     */
085    public void setParameters(Map<String, String> parameters);
086
087    /**
088     * Sets the structure ids.
089     *
090     * @param structureIds the structure ids
091     */
092    public void setStructureIds(List<String> structureIds);
093}