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.sitemap.shared;
029
030import org.opencms.gwt.shared.CmsListInfoBean;
031import org.opencms.gwt.shared.property.CmsClientProperty;
032import org.opencms.util.CmsUUID;
033
034import java.util.Map;
035
036import com.google.gwt.user.client.rpc.IsSerializable;
037
038/**
039 * Bean representing a model page, for use in the model page mode of the sitemap editor.<p>
040 */
041public class CmsModelPageEntry implements IsSerializable {
042
043    /** The resource properties. */
044    private Map<String, CmsClientProperty> m_ownProperties;
045
046    /** The resource type name. */
047    private String m_resourceType;
048
049    /** The site path. */
050    private String m_rootPath;
051
052    /** The structure id. */
053    private CmsUUID m_structureId;
054
055    /** The site path (may be null if in different site). */
056    private String m_sitePath;
057
058    /** The list info bean containing the information to display in widgets showing this entry. */
059    private CmsListInfoBean m_listInfoBean;
060
061    /** The disabled flag. */
062    private boolean m_disabled;
063
064    /** The default page flag. */
065    private boolean m_default;
066
067    /**
068     * Default constructor.<p>
069     */
070    public CmsModelPageEntry() {
071
072        // empty default constructor
073    }
074
075    /**
076     * Returns the listInfoBean.<p>
077     *
078     * @return the listInfoBean
079     */
080    public CmsListInfoBean getListInfoBean() {
081
082        return m_listInfoBean;
083    }
084
085    /**
086     * Returns the ownProperties.<p>
087     *
088     * @return the ownProperties
089     */
090    public Map<String, CmsClientProperty> getOwnProperties() {
091
092        return m_ownProperties;
093    }
094
095    /**
096     * Returns the resourceType.<p>
097     *
098     * @return the resourceType
099     */
100    public String getResourceType() {
101
102        return m_resourceType;
103    }
104
105    /**
106     * Returns the rootPath.<p>
107     *
108     * @return the rootPath
109     */
110    public String getRootPath() {
111
112        return m_rootPath;
113    }
114
115    /**
116     * Returns the sitePath.<p>
117     *
118     * @return the sitePath
119     */
120    public String getSitePath() {
121
122        return m_sitePath;
123    }
124
125    /**
126     * Returns the structureId.<p>
127     *
128     * @return the structureId
129     */
130    public CmsUUID getStructureId() {
131
132        return m_structureId;
133    }
134
135    /**
136     * Returns whether the given page is the default model.<p>
137     *
138     * @return if the given page is the default model
139     */
140    public boolean isDefault() {
141
142        return m_default;
143    }
144
145    /**
146     * Returns if the model page is disabled.<p>
147     *
148     * @return if the model page is disabled
149     */
150    public boolean isDisabled() {
151
152        return m_disabled;
153    }
154
155    /**
156     * Sets if the given page is the default model.<p>
157     *
158     * @param defaultl the given page is the default model
159     */
160    public void setDefault(boolean defaultl) {
161
162        m_default = defaultl;
163    }
164
165    /**
166     * Sets if the model page is disabled.<p>
167     *
168     * @param disabled if the model page is disabled
169     */
170    public void setDisabled(boolean disabled) {
171
172        m_disabled = disabled;
173    }
174
175    /**
176     * Sets the listInfoBean.<p>
177     *
178     * @param listInfoBean the listInfoBean to set
179     */
180    public void setListInfoBean(CmsListInfoBean listInfoBean) {
181
182        m_listInfoBean = listInfoBean;
183    }
184
185    /**
186     * Sets the ownProperties.<p>
187     *
188     * @param ownProperties the ownProperties to set
189     */
190    public void setOwnProperties(Map<String, CmsClientProperty> ownProperties) {
191
192        m_ownProperties = ownProperties;
193    }
194
195    /**
196     * Sets the resourceType.<p>
197     *
198     * @param resourceType the resourceType to set
199     */
200    public void setResourceType(String resourceType) {
201
202        m_resourceType = resourceType;
203    }
204
205    /**
206     * Sets the rootPath.<p>
207     *
208     * @param rootPath the rootPath to set
209     */
210    public void setRootPath(String rootPath) {
211
212        m_rootPath = rootPath;
213    }
214
215    /**
216     * Sets the sitePath.<p>
217     *
218     * @param sitePath the sitePath to set
219     */
220    public void setSitePath(String sitePath) {
221
222        m_sitePath = sitePath;
223    }
224
225    /**
226     * Sets the structureId.<p>
227     *
228     * @param structureId the structureId to set
229     */
230    public void setStructureId(CmsUUID structureId) {
231
232        m_structureId = structureId;
233    }
234}