001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/I_CmsListAction.java,v $
003: * Date : $Date: 2008-02-27 12:05:28 $
004: * Version: $Revision: 1.12 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.workplace.list;
033:
034: import org.opencms.i18n.CmsMessageContainer;
035: import org.opencms.workplace.tools.I_CmsHtmlIconButton;
036:
037: /**
038: * Interface for list actions.<p>
039: *
040: * @author Michael Moossen
041: *
042: * @version $Revision: 1.12 $
043: *
044: * @since 6.0.0
045: */
046: public interface I_CmsListAction extends I_CmsHtmlIconButton {
047:
048: /**
049: * The same using {@link #getWp()}.<p>
050: *
051: * @return the buttons html code
052: *
053: * @see I_CmsHtmlIconButton#buttonHtml(org.opencms.workplace.CmsWorkplace)
054: */
055: String buttonHtml();
056:
057: /**
058: * Returns an optional confirmation message for the action.<p>
059: *
060: * It will be escaped for usage in java script code.<p>
061: *
062: * @return confirmation message
063: */
064: CmsMessageContainer getConfirmationMessage();
065:
066: /**
067: * Returns the id of the associated list.<p>
068: *
069: * @return the id of the associated list
070: */
071: String getListId();
072:
073: /**
074: * Returns the related workplace dialog object, to be able to access dynamic data.<p>
075: *
076: * @return the related workplace dialog object
077: */
078: A_CmsListDialog getWp();
079:
080: /**
081: * Sets the confirmation message.<p>
082: *
083: * @param confirmationMsg the confirmation message to set
084: */
085: void setConfirmationMessage(CmsMessageContainer confirmationMsg);
086:
087: /**
088: * Sets the list id.<p>
089: *
090: * @param listId the id of the list to set
091: */
092: void setListId(String listId);
093:
094: /**
095: * Sets the workplace dialog object.<p>
096: *
097: * @param wp the workplace dialog object
098: */
099: void setWp(A_CmsListDialog wp);
100: }
|