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 GmbH & Co. KG, 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.workplace;
029
030import java.util.ArrayList;
031import java.util.List;
032
033/**
034 * Represents an user additional information block.<p>
035 *
036 * @since 6.5.6
037 */
038public final class CmsWorkplaceUserInfoBlock {
039
040    /** The list of defined entries in the block. */
041    private final List<CmsWorkplaceUserInfoEntry> m_entries;
042
043    /** The block's title. */
044    private String m_title;
045
046    /**
047     * Default constructor.<p>
048     */
049    public CmsWorkplaceUserInfoBlock() {
050
051        m_entries = new ArrayList<CmsWorkplaceUserInfoEntry>();
052    }
053
054    /**
055     * Creates a new entry.<p>
056     *
057     * @param key the additional information key
058     * @param type the class name of the stored data type
059     * @param widget the widget class name
060     * @param params the widget parameters
061     * @param optional if optional
062     */
063    public void addEntry(String key, String type, String widget, String params, String optional) {
064
065        m_entries.add(new CmsWorkplaceUserInfoEntry(key, type, widget, params, optional));
066    }
067
068    /**
069     * Returns a list of all configured additional information entries.<p>
070     *
071     * @return a list of {@link CmsWorkplaceUserInfoEntry} objects
072     */
073    public List<CmsWorkplaceUserInfoEntry> getEntries() {
074
075        return m_entries;
076    }
077
078    /**
079     * Returns the title.<p>
080     *
081     * @return the title
082     */
083    public String getTitle() {
084
085        return m_title;
086    }
087
088    /**
089     * Sets the title.<p>
090     *
091     * @param title the title to set
092     */
093    public void setTitle(String title) {
094
095        m_title = title;
096    }
097}