Interface TextModuleRootModifier

All Superinterfaces:
Modifier<TextModuleRoot>

public interface TextModuleRootModifier extends Modifier<TextModuleRoot>
Defines an API to modify an instance of type TextModuleRoot
Since:
10.0.206
  • Method Details

    • getChildTextModuleFirstLevelGroups

      List<TextModuleFirstLevelGroup> getChildTextModuleFirstLevelGroups()
      Get the current direct child textmodule first level groups list which is held in this TextModuleRootModifier.
      Returns:
      the direct child textmodule first level groups list
      Since:
      10.0.206
    • setChildTextModuleFirstLevelGroups

      TextModuleRootModifier setChildTextModuleFirstLevelGroups(List<TextModuleFirstLevelGroup> childTextModuleFirstLevelGroups) throws ValidationException

      Change the direct child textmodule first level groups list of the associated TextModuleRoot.

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

      Parameters:
      childTextModuleFirstLevelGroups - the new direct child textmodule first level groups list
      Returns:
      the TextModuleRootModifier
      Throws:
      ValidationException - if the new new direct child textmodule first level groups list is invalid
      Since:
      10.0.206
    • validateChildTextModuleFirstLevelGroups

      boolean validateChildTextModuleFirstLevelGroups(List<TextModuleFirstLevelGroup> childTextModuleFirstLevelGroups) throws ValidationException
      Validate the given direct child textmodule first level groups list.
      Parameters:
      childTextModuleFirstLevelGroups - the direct child textmodule first level groups list to validate
      Returns:
      true if the direct child textmodule first level groups list is valid
      Throws:
      ValidationException - if the direct child textmodule first level groups list is invalid
      Since:
      10.0.206