Package org.opencms.workplace.editors

Interface I_CmsPreEditorActionDefinition

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

A_CmsPreEditorActionDefinition, CmsPreEditorActionDefinitionXmlContent

public interface I_CmsPreEditorActionDefinition
extends I_CmsConfigurationParameterHandler

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

Since:

6.5.4

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

Modifier and Type	Method	Description
boolean	doPreAction(CmsResource resource, CmsDialog dialog, 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.
String	getResourceTypeName()	Returns the resource type name for which the action should be performed.
void	setResourceTypeName(String resourceTypeName)	Sets the resource type name for which the action should be performed.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Method Details

doPreAction

boolean doPreAction(CmsResource resource,
 CmsDialog dialog,
 String originalParams)
             throws 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:

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

String getResourceTypeName()

Returns the resource type name for which the action should be performed.

Returns:

the resource type name

setResourceTypeName

void setResourceTypeName(String resourceTypeName)

Sets the resource type name for which the action should be performed.

Parameters:

resourceTypeName - the resource type name