I_CmsListAction


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/I_CmsListAction.java,v $
3    * Date   : $Date: 2005/06/23 11:11:43 $
4    * Version: $Revision: 1.9 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.workplace.list;
33  
34  import org.opencms.i18n.CmsMessageContainer;
35  import org.opencms.workplace.tools.I_CmsHtmlIconButton;
36  
37  /**
38   * Interface for list actions.<p>
39   * 
40   * @author Michael Moossen  
41   * 
42   * @version $Revision: 1.9 $ 
43   * 
44   * @since 6.0.0 
45   */
46  public interface I_CmsListAction extends I_CmsHtmlIconButton {
47  
48      /**
49       * Returns an optional confirmation message for the action.<p>
50       * 
51       * It will be escaped for usage in java script code.<p> 
52       * 
53       * @return confirmation message
54       */
55      CmsMessageContainer getConfirmationMessage();
56  
57      /**
58       * Returns the id of the associated list.<p>
59       * 
60       * @return the id of the associated list
61       */
62      String   getListId();
63  
64      /**
65       * Sets the confirmation message.<p>
66       *
67       * @param confirmationMsg the confirmation message to set
68       */
69      void setConfirmationMessage(CmsMessageContainer confirmationMsg);
70  
71      /**
72       * Sets the list id.<p>
73       *
74       * @param listId the id of the list to set
75       */
76      void setListId(String   listId);
77  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags