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.ui.apps.projects;
029
030import org.opencms.file.CmsObject;
031import org.opencms.main.OpenCms;
032import org.opencms.security.CmsRole;
033import org.opencms.ui.FontOpenCms;
034import org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration;
035import org.opencms.ui.apps.CmsAppVisibilityStatus;
036import org.opencms.ui.apps.CmsWorkplaceAppManager;
037import org.opencms.ui.apps.I_CmsWorkplaceApp;
038import org.opencms.ui.apps.Messages;
039
040import java.util.Locale;
041
042import com.vaadin.server.Resource;
043
044/**
045 * The project overview app configuration. Available for workplace users that do not have the project manager role.<p>
046 */
047public class CmsProjectOverviewConfiguration extends A_CmsWorkplaceAppConfiguration {
048
049    /** The app id. */
050    public static final String APP_ID = "project-overview";
051
052    /**
053     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppCategory()
054     */
055    @Override
056    public String getAppCategory() {
057
058        return CmsWorkplaceAppManager.ADMINISTRATION_CATEGORY_ID;
059    }
060
061    /**
062     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppInstance()
063     */
064    public I_CmsWorkplaceApp getAppInstance() {
065
066        return new CmsProjectManager();
067    }
068
069    /**
070     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getHelpText(java.util.Locale)
071     */
072    @Override
073    public String getHelpText(Locale locale) {
074
075        return Messages.get().getBundle(locale).key(Messages.GUI_PROJECTS_OVERVIEW_HELP_0);
076    }
077
078    /**
079     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getIcon()
080     */
081    public Resource getIcon() {
082
083        return FontOpenCms.PROJECT;
084    }
085
086    /**
087     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getId()
088     */
089    public String getId() {
090
091        return APP_ID;
092    }
093
094    /**
095     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getName(java.util.Locale)
096     */
097    @Override
098    public String getName(Locale locale) {
099
100        return Messages.get().getBundle(locale).key(Messages.GUI_PROJECTS_OVERVIEW_TITLE_0);
101    }
102
103    /**
104     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getOrder()
105     */
106    @Override
107    public int getOrder() {
108
109        return 5;
110    }
111
112    /**
113     * @see org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration#getVisibility(org.opencms.file.CmsObject)
114     */
115    @Override
116    public CmsAppVisibilityStatus getVisibility(CmsObject cms) {
117
118        CmsAppVisibilityStatus status = !OpenCms.getRoleManager().hasRole(cms, CmsRole.PROJECT_MANAGER)
119            && OpenCms.getRoleManager().hasRole(cms, CmsRole.WORKPLACE_USER)
120            ? CmsAppVisibilityStatus.ACTIVE
121            : CmsAppVisibilityStatus.INVISIBLE;
122        return status;
123    }
124}