org.opencms.setup.xml

接口 I_CmsSetupXmlUpdate

所有已知实现类:

A_CmsSetupXmlUpdate, A_CmsXmlSearch, A_CmsXmlVfs, A_CmsXmlWorkplace, CmsXmlAddAdeConfig, CmsXmlAddADESearch, CmsXmlAddAutoSetFeatures, CmsXmlAddAvailabilityContextMenu, CmsXmlAddCollectors, CmsXmlAddContentNotification, CmsXmlAddContextMenuItems, CmsXmlAddDEHelpSearchIndex, CmsXmlAddHtmlConverters, CmsXmlAddIconRules, CmsXmlAddImageLoader, CmsXmlAddImgGalleryContextMenues, CmsXmlAddImgGalleryParam, CmsXmlAddImmutables, CmsXmlAddImportVersions, CmsXmlAddJspLoaderParams, CmsXmlAddLoaders, CmsXmlAddMimeTypes, CmsXmlAddMultiContextMenu, CmsXmlAddPublishButtonAppearance, CmsXmlAddResourceHandlers, CmsXmlAddResourceHandlers, CmsXmlAddResourcesToRender, CmsXmlAddResourceTypeParams, CmsXmlAddResourceTypes, CmsXmlAddSharedFolderConfiguration, CmsXmlAddSitemapConfig, CmsXmlAddSolrSearch, CmsXmlAddTimezone, CmsXmlAddTranslationRules, CmsXmlAddTypeMappings, CmsXmlAddUnknownFile, CmsXmlAddWidgets, CmsXmlAddWizardETypeDesc, CmsXmlAddXmlContentWidgets, CmsXmlAddXmlSchemaTypes, CmsXmlChangeDefaultDirectEditProvider, CmsXmlChangeDefaultUpload, CmsXmlChangeGalleryClasses, CmsXmlCleanUpSearchConfiguration, CmsXmlFixContextMenuItems, CmsXmlRemoveImmutables, CmsXmlRemoveImportHandlers, CmsXmlRemoveImportVersions, CmsXmlRemovePageSearchIndexSource1, CmsXmlRemoveResourceHandlers, CmsXmlRemoveResourceLoaders, CmsXmlRemoveResourcesToRender, CmsXmlRemoveResourceTypes, CmsXmlRemoveSysSearchIndex, CmsXmlReplaceHtmlAreaWidgets, CmsXmlSetCategoryFolder, CmsXmlUpdateContextMenuEntries, CmsXmlUpdateDefaultPermissions, CmsXmlUpdateDefaultProperties, CmsXmlUpdateDirectEditProvider, CmsXmlUpdateExplorerTypes, CmsXmlUpdateFlexcache, CmsXmlUpdateHistoryContextMenu, CmsXmlUpdateLocalizationKeys, CmsXmlUpdateMenuRules, CmsXmlUpdateOpenGallery

public interface I_CmsSetupXmlUpdate

Represent a change to be applied to a xml file.

从以下版本开始:

6.1.8

方法概要

方法

限定符和类型	方法和说明
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.

方法详细资料

execute

void execute(CmsSetupBean setupBean)
             throws java.lang.Exception

Execute the change.

参数:

setupBean - the setup bean

抛出:

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.

参数:

setupBean - the setup bean

返回:

the code to be changed

抛出:

java.lang.Exception - if something goes wrong

getName

java.lang.String getName()

Returns the nice name for the change.

返回:

the nice name

getXmlFilename

java.lang.String getXmlFilename()

Returns the affected xml configuration file name.

返回:

the xml file name

validate

boolean validate(CmsSetupBean setupBean)
                 throws java.lang.Exception

Validates the need to apply this change.

参数:

setupBean - the setup bean

返回:

true if needed

抛出:

java.lang.Exception - if something goes wrong