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.list;
029
030import org.opencms.i18n.CmsMessageContainer;
031import org.opencms.workplace.tools.I_CmsHtmlIconButton;
032
033/**
034 * Interface for list actions.<p>
035 *
036 * @since 6.0.0
037 */
038public interface I_CmsListAction extends I_CmsHtmlIconButton {
039
040    /**
041     * The same using {@link #getWp()}.<p>
042     *
043     * @return the buttons html code
044     *
045     * @see I_CmsHtmlIconButton#buttonHtml(org.opencms.workplace.CmsWorkplace)
046     */
047    String buttonHtml();
048
049    /**
050     * Returns an optional confirmation message for the action.<p>
051     *
052     * It will be escaped for usage in java script code.<p>
053     *
054     * @return confirmation message
055     */
056    CmsMessageContainer getConfirmationMessage();
057
058    /**
059     * Returns the id of the associated list.<p>
060     *
061     * @return the id of the associated list
062     */
063    String getListId();
064
065    /**
066     * Returns the related workplace dialog object, to be able to access dynamic data.<p>
067     *
068     * @return the related workplace dialog object
069     */
070    A_CmsListDialog getWp();
071
072    /**
073     * Sets the confirmation message.<p>
074     *
075     * @param confirmationMsg the confirmation message to set
076     */
077    void setConfirmationMessage(CmsMessageContainer confirmationMsg);
078
079    /**
080     * Sets the list id.<p>
081     *
082     * @param listId the id of the list to set
083     */
084    void setListId(String listId);
085
086    /**
087     * Sets the workplace dialog object.<p>
088     *
089     * @param wp the workplace dialog object
090     */
091    void setWp(A_CmsListDialog wp);
092}