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.actions;
029
030import org.opencms.ui.I_CmsDialogContext;
031import org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility;
032
033import java.util.Locale;
034
035/**
036 * Workplace action interface.<p>
037 */
038public interface I_CmsWorkplaceAction extends I_CmsHasMenuItemVisibility {
039
040    /**
041     * Executes the action.<p>
042     *
043     * @param context the current dialog context.<p>
044     */
045    void executeAction(I_CmsDialogContext context);
046
047    /**
048     * The action id.<p>
049     *
050     * @return the action id
051     */
052    String getId();
053
054    /**
055     * Returns the localized action title.<p>
056     *
057     * @param locale the user's workplace locale
058     *
059     * @return the action title
060     */
061    String getTitle(Locale locale);
062
063    /**
064     * Checks whether this action should be active in the given dialog context.<p>
065     *
066     * @param context the dialog context
067     *
068     * @return <code>true</code> if this action should be active in the given dialog context
069     */
070    boolean isActive(I_CmsDialogContext context);
071}