Package org.opencms.workplace.tools.content

Class CmsElementChangeLocaleSettings

  • public class CmsElementChangeLocaleSettings
extends java.lang.Object
    Settings object that provides the settings to convert page locales from one locale to another.

    Since:
    6.0.1

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getNewLocale()
      Returns the new Locale to use for the page elements.
      java.lang.String getOldLocale()
      Returns the old Locale of the page elements.
      java.lang.String getTemplate()
      Returns the template for the pages that should be converted.
      java.lang.String getVfsFolder()
      Returns the VFS folder in OpenCms to start the conversion from.
      boolean isIncludeSubFolders()
      Returns the flag indicating if resources in sub folders should be changed, too.
      void setIncludeSubFolders​(boolean includeSubFolders)
      Sets the flag indicating if resources in sub folders should be changed, too.
      void setNewLocale​(java.lang.String newLocale)
      Sets the new Locale to use for the page elements.
      void setOldLocale​(java.lang.String oldLocale)
      Sets the old Locale of the page elements.
      void setTemplate​(java.lang.String template)
      Sets the template for the pages that should be converted.
      void setVfsFolder​(java.lang.String vfsFolder)
      Sets the VFS folder in OpenCms to start the conversion from.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getNewLocale

        public java.lang.String getNewLocale()
        Returns the new Locale to use for the page elements.

        Returns:
        the new Locale to use for the page elements

      • getOldLocale

        public java.lang.String getOldLocale()
        Returns the old Locale of the page elements.

        Returns:
        the old Locale of the page elements

      • getTemplate

        public java.lang.String getTemplate()
        Returns the template for the pages that should be converted.

        Returns:
        the template for the pages that should be converted

      • getVfsFolder

        public java.lang.String getVfsFolder()
        Returns the VFS folder in OpenCms to start the conversion from.

        Returns:
        the VFS folder in OpenCms to start the conversion from

      • isIncludeSubFolders

        public boolean isIncludeSubFolders()
        Returns the flag indicating if resources in sub folders should be changed, too.

        Returns:
        the flag indicating if resources in sub folders should be changed, too

      • setIncludeSubFolders

        public void setIncludeSubFolders​(boolean includeSubFolders)
        Sets the flag indicating if resources in sub folders should be changed, too.

        Parameters:
        includeSubFolders - the flag indicating if resources in sub folders should be changed, too

      • setNewLocale

        public void setNewLocale​(java.lang.String newLocale)
        Sets the new Locale to use for the page elements.

        Parameters:
        newLocale - the new Locale to use for the page elements

      • setOldLocale

        public void setOldLocale​(java.lang.String oldLocale)
        Sets the old Locale of the page elements.

        Parameters:
        oldLocale - the old Locale of the page elements

      • setTemplate

        public void setTemplate​(java.lang.String template)
        Sets the template for the pages that should be converted.

        Parameters:
        template - the template for the pages that should be converted

      • setVfsFolder

        public void setVfsFolder​(java.lang.String vfsFolder)
        Sets the VFS folder in OpenCms to start the conversion from.

        Parameters:
        vfsFolder - the VFS folder in OpenCms to start the conversion from