org.opencms.setup.xml
Interface I_CmsSetupXmlUpdate

All Known Implementing Classes:
A_CmsSetupXmlUpdate, A_CmsXmlWorkplace, CmsXmlAddAutoSetFeatures, CmsXmlAddAvailabilityContextMenu, CmsXmlAddBackupResourceHandler, CmsXmlAddContentNotification, CmsXmlAddDEHelpSearchIndex, CmsXmlAddImageLoader, CmsXmlAddImgGalleryContextMenues, CmsXmlAddImgGalleryParam, CmsXmlAddImportClasses, CmsXmlAddMimeTypes, CmsXmlAddMultiContextMenu, CmsXmlAddPublishButtonAppearance, CmsXmlAddXmlContentWidgets, CmsXmlRemovePageSearchIndexSource1, CmsXmlRemoveSysSearchIndex, CmsXmlReplaceHtmlAreaWidgets, CmsXmlUpdateDefaultPermissions, CmsXmlUpdateDefaultProperties, 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.
 java.lang.String getCodeToChange(CmsSetupBean setupBean)
          Returns the code to be added OR removed in the xml file.
 java.lang.String getName()
          Returns the nice name for the change.
 java.lang.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 java.lang.Exception
Execute the change.

Parameters:
setupBean - the setup bean
Throws:
java.lang.Exception - if something goes wrong

getCodeToChange

java.lang.String getCodeToChange(CmsSetupBean setupBean)
                                 throws java.lang.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:
java.lang.Exception - if something goes wrong

getName

java.lang.String getName()
Returns the nice name for the change.

Returns:
the nice name

getXmlFilename

java.lang.String getXmlFilename()
Returns the affected xml configuration file name.

Returns:
the xml file name

validate

boolean validate(CmsSetupBean setupBean)
                 throws java.lang.Exception
Validates the need to apply this change.

Parameters:
setupBean - the setup bean
Returns:
true if needed
Throws:
java.lang.Exception - if something goes wrong