org.opencms.setup.xml
Interface I_CmsSetupXmlUpdate

All Known Implementing Classes:

A_CmsSetupXmlUpdate, A_CmsXmlWorkplace, CmsXmlAddAutoSetFeatures, CmsXmlAddAvailabilityContextMenu, CmsXmlAddBackupResourceHandler, CmsXmlAddContentNotification, CmsXmlAddDEHelpSearchIndex, CmsXmlAddImageLoader, CmsXmlAddImgGalleryContextMenues, CmsXmlAddImgGalleryParam, CmsXmlAddMultiContextMenu, CmsXmlAddPublishButtonAppearance, CmsXmlAddXmlContentWidgets, CmsXmlRemovePageSearchIndexSource1, CmsXmlRemoveSysSearchIndex, CmsXmlReplaceHtmlAreaWidgets, CmsXmlUpdateDefaultPermissions, CmsXmlUpdateHistoryContextMenu, CmsXmlUpdateLocalizationKeys

public interface I_CmsSetupXmlUpdate

Represent a change to be applied to a xml file.

Since:

6.1.8

Version:

$Revision: 1.2 $

Author:

Michael Moossen

Method Summary

void	execute(CmsSetupBean setupBean) Execute the change.
String	getCodeToChange(CmsSetupBean setupBean) Returns the code to be added OR removed in the xml file.
String	getName() Returns the nice name for the change.
String	getXmlFilename() Returns the affected xml configuration file name.
boolean	validate(CmsSetupBean setupBean) Validates the need to apply this change.

Method Detail

execute

void execute(CmsSetupBean setupBean)
             throws Exception

Execute the change.

Parameters:

setupBean - the setup bean

Throws:

Exception - if something goes wrong

getCodeToChange

String getCodeToChange(CmsSetupBean setupBean)
                       throws Exception

Returns the code to be added OR removed in the xml file.

Parameters:

setupBean - the setup bean

Returns:

the code to be changed

Throws:

Exception - if something goes wrong

getName

String getName()

Returns the nice name for the change.

Returns:

the nice name

getXmlFilename

String getXmlFilename()

Returns the affected xml configuration file name.

Returns:

the xml file name

validate

boolean validate(CmsSetupBean setupBean)
                 throws Exception

Validates the need to apply this change.

Parameters:

setupBean - the setup bean

Returns:

true if needed

Throws:

Exception - if something goes wrong