001/*
002 * File   : $Source$
003 * Date   : $Date$
004 * Version: $Revision$
005 *
006 * This library is part of OpenCms -
007 * the Open Source Content Management System
008 *
009 * Copyright (C) 2002 - 2011 Alkacon Software (http://www.alkacon.com)
010 *
011 * This library is free software; you can redistribute it and/or
012 * modify it under the terms of the GNU Lesser General Public
013 * License as published by the Free Software Foundation; either
014 * version 2.1 of the License, or (at your option) any later version.
015 *
016 * This library is distributed in the hope that it will be useful,
017 * but WITHOUT ANY WARRANTY; without even the implied warranty of
018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 * Lesser General Public License for more details.
020 *
021 * For further information about Alkacon Software, please see the
022 * company website: http://www.alkacon.com
023 *
024 * For further information about OpenCms, please see the
025 * project website: http://www.opencms.org
026 *
027 * You should have received a copy of the GNU Lesser General Public
028 * License along with this library; if not, write to the Free Software
029 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
030 */
031
032package org.opencms.ade.containerpage.inherited;
033
034import org.opencms.file.CmsResource;
035
036import java.util.Locale;
037
038/**
039 * Reference to an container inheritance configuration.<p>
040 *
041 */
042public class CmsInheritanceReference {
043
044    /** The description. */
045    private String m_description;
046
047    /** The locale. */
048    private Locale m_locale;
049
050    /** The container configuration name. */
051    private String m_name;
052
053    /** The resource from which this reference has been read. */
054    private CmsResource m_resource;
055
056    /** The title. */
057    private String m_title;
058
059    /**
060     * Creates a new instance.<p>
061     *
062     * @param name the container configuration name
063     * @param title the title
064     * @param description the description
065     * @param res the resource
066     * @param locale the locale
067     */
068    public CmsInheritanceReference(String name, String title, String description, CmsResource res, Locale locale) {
069
070        m_title = title;
071        m_name = name;
072        m_description = description;
073        m_resource = res;
074        m_locale = locale;
075    }
076
077    /**
078     * Returns the description.<p>
079     *
080     * @return the description
081     */
082    public String getDescription() {
083
084        return m_description;
085    }
086
087    /**
088     * Gets the locale.<p>
089     *
090     * @return the locale
091     */
092    public Locale getLocale() {
093
094        return m_locale;
095    }
096
097    /**
098     * Gets the configuration name.<p>
099     *
100     * @return the configuration name
101     */
102    public String getName() {
103
104        return m_name;
105    }
106
107    /**
108     * Gets the reference resource.<p>
109     *
110     * @return the reference resource
111     */
112    public CmsResource getResource() {
113
114        return m_resource;
115    }
116
117    /**
118     * Gets the title.<p>
119     *
120     * @return the title
121     */
122    public String getTitle() {
123
124        return m_title;
125    }
126
127}