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.publishqueue;
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.I_CmsWorkplaceApp;
037import org.opencms.ui.apps.Messages;
038
039import java.util.Locale;
040
041import com.vaadin.server.Resource;
042
043/**
044 * Configuration class for the publish queue app.<p>
045 */
046public class CmsPublishQueueConfiguration extends A_CmsWorkplaceAppConfiguration {
047
048    /** ID of the app. */
049    public static final String APP_ID = "publishqueue";
050
051    /**
052     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppInstance()
053     */
054    public I_CmsWorkplaceApp getAppInstance() {
055
056        return new CmsPublishQueue();
057    }
058
059    /**
060     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getHelpText(java.util.Locale)
061     */
062    @Override
063    public String getHelpText(Locale locale) {
064
065        return Messages.get().getBundle(locale).key(Messages.GUI_PQUEUE_HELP_0);
066    }
067
068    /**
069     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getIcon()
070     */
071    public Resource getIcon() {
072
073        return FontOpenCms.PUBLISH;
074
075    }
076
077    /**
078     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getId()
079     */
080    public String getId() {
081
082        return APP_ID;
083    }
084
085    /**
086     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getName(java.util.Locale)
087     */
088    @Override
089    public String getName(Locale locale) {
090
091        return Messages.get().getBundle(locale).key(Messages.GUI_PQUEUE_TITLE_0);
092    }
093
094    /**
095     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getOrder()
096     */
097    @Override
098    public int getOrder() {
099
100        return 5;
101    }
102
103    /**
104     * @see org.opencms.ui.apps.A_CmsWorkplaceAppConfiguration#getRequiredRole()
105     */
106    @Override
107    public CmsRole getRequiredRole() {
108
109        return CmsRole.EDITOR;
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.EDITOR)
119        ? new CmsAppVisibilityStatus(false, true, "")
120        : CmsAppVisibilityStatus.INVISIBLE;
121        return status;
122    }
123}