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 com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * Sitemap info object. Contains descriptive info about the current site/sub-site.<p>
034 *
035 * @since 8.0.2
036 */
037public class CmsSitemapInfo implements IsSerializable {
038
039    /** The current project. */
040    private String m_currentProject;
041
042    /** Site description. */
043    private String m_description;
044
045    /** The site default locale. */
046    private String m_siteLocale;
047
048    /** The name of the current site. */
049    private String m_siteHost;
050
051    /** The site title. */
052    private String m_title;
053
054    /**
055     * Constructor for serialization only.<p>
056     */
057    protected CmsSitemapInfo() {
058
059    }
060
061    /**
062     * Constructor.<p>
063     *
064     * @param currentProject the current project
065     * @param description the site description
066     * @param siteLocale the site default locale
067     * @param siteHost the site host
068     * @param title the title
069     */
070    public CmsSitemapInfo(String currentProject, String description, String siteLocale, String siteHost, String title) {
071
072        m_currentProject = currentProject;
073        m_description = description;
074        m_siteLocale = siteLocale;
075        m_siteHost = siteHost;
076        m_title = title;
077    }
078
079    /**
080     * Returns the current project.<p>
081     *
082     * @return the current project
083     */
084    public String getCurrentProject() {
085
086        return m_currentProject;
087    }
088
089    /**
090     * Returns the description.<p>
091     *
092     * @return the description
093     */
094    public String getDescription() {
095
096        return m_description;
097    }
098
099    /**
100     * Returns the site default locale.<p>
101     *
102     * @return the site default locale
103     */
104    public String getSiteLocale() {
105
106        return m_siteLocale;
107    }
108
109    /**
110     * Returns the host of the current site.<p>
111     *
112     * @return the host of the current site
113     */
114    public String getSiteHost() {
115
116        return m_siteHost;
117    }
118
119    /**
120     * Returns the title.<p>
121     *
122     * @return the title
123     */
124    public String getTitle() {
125
126        return m_title;
127    }
128}