org.opencms.workplace.editors
Interface I_CmsPreEditorActionDefinition

All Known Implementing Classes:
A_CmsPreEditorActionDefinition, CmsPreEditorActionDefinitionXmlContent

public interface I_CmsPreEditorActionDefinition

Defines an action to be performed before the workplace editor is opened for the first time.

Since:
6.5.4
Version:
$Revision: 1.6 $
Author:
Andreas Zahner

Method Summary
 boolean doPreAction(CmsResource resource, CmsDialog dialog, java.lang.String originalParams)
          Returns if an action has to be performed before opening the editor depending on the resource to edit and eventual request parameter values.
 I_CmsResourceType getResourceType()
          Returns the resource type for which the action should be performed.
 java.lang.String getResourceTypeName()
          Returns the resource type name for which the action should be performed.
 void setResourceTypeName(java.lang.String resourceTypeName)
          Sets the resource type name for which the action should be performed.
 

Method Detail

doPreAction

boolean doPreAction(CmsResource resource,
                    CmsDialog dialog,
                    java.lang.String originalParams)
                    throws java.lang.Exception
Returns if an action has to be performed before opening the editor depending on the resource to edit and eventual request parameter values.

Parameters:
resource - the resource to be edited
dialog - the dialog instance
originalParams - the original request parameters as String passed to the editor
Returns:
true if an action has to be performed before opening the editor
Throws:
java.lang.Exception - if something goes wrong

getResourceType

I_CmsResourceType getResourceType()
Returns the resource type for which the action should be performed.

Returns:
the resource type

getResourceTypeName

java.lang.String getResourceTypeName()
Returns the resource type name for which the action should be performed.

Returns:
the resource type name

setResourceTypeName

void setResourceTypeName(java.lang.String resourceTypeName)
Sets the resource type name for which the action should be performed.

Parameters:
resourceTypeName - the resource type name