Package com.novomind.ecom.api.imail.routing.persistence

Interface TextModuleModifier

    • Method Detail

      • isVisible

        boolean isVisible()
        Get the current visibility which is held in this TextModuleNodeModifier.
        Returns:
        true if visible, otherwise false
        Since:
        10.0.206

      • validateVisible

        boolean validateVisible​(boolean visible)
                 throws ValidationException
        Validate the given visibility.
        Parameters:
        visible - the new visibility
        Returns:
        true if the change is valid
        Throws:
        ValidationException - if the change is invalid
        Since:
        10.0.206

      • getDescription

        java.lang.String getDescription()
        Get the current textmodule description which is held in this TextModuleModifier.
        Returns:
        the description as String
        Since:
        10.0.206

      • setDescription

        TextModuleModifier setDescription​(java.lang.String description)
                           throws ValidationException

        Change the description of the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Parameters:
        description - the new description as String
        Returns:
        the TextModuleModifier
        Throws:
        ValidationException - if the new description is invalid
        Since:
        10.0.206

      • validateDescription

        boolean validateDescription​(java.lang.String description)
                     throws ValidationException
        Validate the given description.
        Parameters:
        description - the description to validate as String
        Returns:
        true if the description is valid
        Throws:
        ValidationException - if the description is invalid
        Since:
        10.0.206

      • getLanguageCode

        java.lang.String getLanguageCode()
        Returns:
        the current ISO 639-1 language code which is held in this TextModuleModifier.
        Since:
        10.0.206

      • setLanguageCode

        TextModuleModifier setLanguageCode​(java.lang.String languageCode)
                            throws ValidationException

        Change the ISO 639-1 language code of the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Parameters:
        languageCode - the new ISO 639-1 language code as String or null to remove the language
        Returns:
        the TextModuleModifier
        Throws:
        ValidationException - if the new ISO 639-1 language code is invalid
        Since:
        10.0.206

      • validateLanguageCode

        boolean validateLanguageCode​(java.lang.String languageCode)
                      throws ValidationException
        Validate the given ISO 639-1 language code.
        Parameters:
        languageCode - the ISO 639-1 language code to validate as String
        Returns:
        true if the ISO 639-1 language code is valid
        Throws:
        ValidationException - if the ISO 639-1 language code is invalid
        Since:
        10.0.206

      • getShortcut

        java.lang.String getShortcut()
        Returns:
        the current shortcut which is held in this TextModuleModifier.
        Since:
        10.0.206

      • setShortcut

        TextModuleModifier setShortcut​(java.lang.String shortcut)
                        throws ValidationException

        Change the shortcut of the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Parameters:
        shortcut - the new shortcut as String
        Returns:
        the TextModuleModifier
        Throws:
        ValidationException - if the new shortcut is invalid
        Since:
        10.0.206

      • validateShortcut

        boolean validateShortcut​(java.lang.String shortcut)
                  throws ValidationException
        Validate the given shortcut.
        Parameters:
        shortcut - the shortcut to validate as String
        Returns:
        true if the shortcut is valid
        Throws:
        ValidationException - if the shortcut is invalid
        Since:
        10.0.206

      • isTopTextRelevant

        boolean isTopTextRelevant()
        Returns:
        the current top text relevancy which is held in this TextModuleModifier.
        Since:
        10.0.206

      • setTopTextRelevant

        TextModuleModifier setTopTextRelevant​(boolean topTextRelevant)
                               throws ValidationException

        Change the top text relevancy of the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Parameters:
        topTextRelevant - the new top text relevancy
        Returns:
        the TextModuleModifier
        Throws:
        ValidationException - if the new top text relevancy is invalid
        Since:
        10.0.206

      • validateTopTextRelevant

        boolean validateTopTextRelevant​(boolean topTextRelevant)
                         throws ValidationException
        Validate the given top text relevancy.
        Parameters:
        topTextRelevant - the top text relevancy to validate
        Returns:
        true if the top text relevancy is valid
        Throws:
        ValidationException - if the top text relevancy is invalid
        Since:
        10.0.206

      • getContent

        java.lang.String getContent()
        Returns:
        the current content which is held in this TextModuleModifier.
        Since:
        10.0.206

      • setContent

        TextModuleModifier setContent​(java.lang.String content)
                       throws ValidationException

        Change the content of the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Parameters:
        content - the new content as String
        Returns:
        the TextModuleModifier
        Throws:
        ValidationException - if the new content is invalid
        Since:
        10.0.206

      • validateContent

        boolean validateContent​(java.lang.String content)
                 throws ValidationException
        Validate the given content.
        Parameters:
        content - the content to validate
        Returns:
        true if the content is valid
        Throws:
        ValidationException - if the content is invalid
        Since:
        10.0.206

      • getLastChangeDateWithNotify

        java.util.Optional<java.util.Date> getLastChangeDateWithNotify()
        Returns:
        the current optional last save date with notify agents activated which is held in this TextModuleModifier.
        Since:
        11.32

      • activateNotification

        TextModuleModifier activateNotification()

        Set the last save date with notify agents activated to the time of persisting the associated TextModule.

        The change is applied after the Modifier.write() method is called.

        Returns:
        the TextModuleModifier
        Since:
        11.32