org.opencms.workplace.list
Interface I_CmsListAction

All Superinterfaces:
I_CmsHtmlIconButton
All Known Subinterfaces:
I_CmsListDirectAction, I_CmsSearchMethod
All Known Implementing Classes:
A_CmsListAction, CmsListDirectAction, CmsListSearchAction

public interface I_CmsListAction
extends I_CmsHtmlIconButton

Interface for list actions.

Since:
6.0.0
Version:
$Revision: 1.9 $
Author:
Michael Moossen

Method Summary
 CmsMessageContainer getConfirmationMessage()
          Returns an optional confirmation message for the action.
 java.lang.String getListId()
          Returns the id of the associated list.
 void setConfirmationMessage(CmsMessageContainer confirmationMsg)
          Sets the confirmation message.
 void setListId(java.lang.String listId)
          Sets the list id.
 
Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton
buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible
 

Method Detail

getConfirmationMessage

public CmsMessageContainer getConfirmationMessage()
Returns an optional confirmation message for the action.

It will be escaped for usage in java script code.

Returns:
confirmation message

getListId

public java.lang.String getListId()
Returns the id of the associated list.

Returns:
the id of the associated list

setConfirmationMessage

public void setConfirmationMessage(CmsMessageContainer confirmationMsg)
Sets the confirmation message.

Parameters:
confirmationMsg - the confirmation message to set

setListId

public void setListId(java.lang.String listId)
Sets the list id.

Parameters:
listId - the id of the list to set