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.ade.contenteditor.shared;
029
030import org.opencms.util.CmsUUID;
031
032import com.google.gwt.user.client.rpc.IsSerializable;
033
034/**
035 * Data which needs to be passed to the edit handler when using the 'new' button for an editable list element.<p>
036 */
037public class CmsEditHandlerData implements IsSerializable {
038
039    /** The client id of the editable element. */
040    private String m_clientId;
041
042    /** The option chosen by the user. */
043    private String m_option;
044
045    /** The container page's structure id. */
046    private CmsUUID m_pageContextId;
047
048    /** The string containing the request parameters. */
049    private String m_requestParams;
050
051    /**
052     * Default constructor for serialization.<p>
053     */
054    public CmsEditHandlerData() {
055
056        // hidden default constructor for serialization
057    }
058
059    /**
060     * Creates a new instance.<p>
061     *
062     * @param clientId the client id of the editable element
063     * @param option the option chosen by the user
064     * @param pageContextId the structure id of the container page
065     * @param requestParams the string containing the request parameters
066     */
067    public CmsEditHandlerData(String clientId, String option, CmsUUID pageContextId, String requestParams) {
068
069        m_clientId = clientId;
070        m_option = option;
071        m_pageContextId = pageContextId;
072        m_requestParams = requestParams;
073
074    }
075
076    /**
077     * Gets the client id of the element.<p>
078     *
079     * @return the client id of the element
080     */
081    public String getClientId() {
082
083        return m_clientId;
084    }
085
086    /**
087     * Gets the option chosen by the user.<p>
088     *
089     * @return the option chosen by the user
090     */
091    public String getOption() {
092
093        return m_option;
094    }
095
096    /**
097     * Gets the container page's structure id.<p>
098     *
099     * @return the container page's structure id
100     */
101    public CmsUUID getPageContextId() {
102
103        return m_pageContextId;
104    }
105
106    /**
107     * Gets the string containing the request parameters from the URL.<p>
108     *
109     * @return the string with the request parameters from the URL
110     */
111    public String getRequestParams() {
112
113        return m_requestParams;
114    }
115
116}