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

Interface TextModuleNodeModifier<T extends TextModuleNode & MasterEntity>

Type Parameters:
T - the type of text module node modified by this modifier
All Superinterfaces:
Modifier<T>
All Known Subinterfaces:
TextModuleFirstLevelGroupModifier, TextModuleGroupModifier<T>, TextModuleModifier, TextModuleSecondLevelGroupModifier
public interface TextModuleNodeModifier<T extends TextModuleNode & MasterEntity> extends Modifier<T>
Defines an API to modify an instance of type TextModuleNode
Since:
10.0.206

  • Method Details

    • getName

      String getName()
      Get the current textmodule node name which is held in this TextModuleNodeModifier.
      Returns:
      the name as String
      Since:
      10.0.206

    • setName

      TextModuleNodeModifier<T> setName(String name) throws ValidationException

      Change the name of the associated TextModuleNode.

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

      Parameters:
      name - the new name as String
      Returns:
      the TextModuleNodeModifier
      Throws:
      ValidationException - if the new name is invalid
      Since:
      10.0.206

    • validateName

      boolean validateName(String name) throws ValidationException
      Validate the given name.
      Parameters:
      name - the name to validate as String
      Returns:
      true if the name is valid
      Throws:
      ValidationException - if the name is invalid
      Since:
      10.0.206

    • getExternalId

      String getExternalId()
      Get the current external id which is held in this TextModuleNodeModifier.
      Returns:
      the external id as String, or null if none is set
      Since:
      13.14

    • setExternalId

      TextModuleNodeModifier<T> setExternalId(String externalId) throws ValidationException

      Change the external id of the associated TextModuleNode.

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

      Parameters:
      externalId - the new external id as String, or null or an empty string to remove it
      Returns:
      the TextModuleNodeModifier
      Throws:
      ValidationException - if the new external id is invalid (its UTF-8 encoding exceeds 256 bytes, i.e. multi-byte characters count as more than one byte, or it is already used by another text module node)
      Since:
      13.14

    • validateExternalId

      boolean validateExternalId(String externalId) throws ValidationException
      Validate the given external id.
      Parameters:
      externalId - the external id to validate as String
      Returns:
      true if the external id is valid
      Throws:
      ValidationException - if the external id is invalid (its UTF-8 encoding exceeds 256 bytes, i.e. multi-byte characters count as more than one byte, or it is already used by another text module node)
      Since:
      13.14