senselogic.sitevision.api.webresource.webcontent

Interface TextModuleUpdater

public interface TextModuleUpdater

Builder for updating existing text modules (text portlets) with new content.

Required configuration:

• Text module - the existing text module node to update
• Content - the new text content and its format

Usage example:

    import createContentFactory from '@sitevision/api/server/CreateContentFactory';
    // Script module and legacy apps would typically use the require function:
    // const createContentFactory = require('CreateContentFactory');

    const updater = createContentFactory.getTextModuleUpdater();
    updater
       .setTextModule(existingTextModuleNode)
       .setMarkdownContent('# Updated Title\n\nThis content has been **updated**.');

    // Optionally check if configuration is valid before executing
    if (updater.isValid()) {
       const node = updater.execute();
    }
 

Important notes:

• The update operation replaces the entire content of the text module
• The text module must be a text portlet (portlet ID "text")
• The text module must be on a page

Permission requirements:

The current user must have permission to update the parent page. An exception will be thrown during execute() if the user lacks the necessary permissions.

An instance of the Sitevision class implementing this interface can be obtained via CreateContentFactory.getTextModuleUpdater(). See CreateContentFactory for how to obtain an instance of the CreateContentFactory interface.

Since:

Sitevision 2026.01.1

Author:

Jens Kalshoven

Method Summary

Modifier and Type	Method and Description
Node	execute() Updates the text module with the new configured content.
boolean	isValid() Best-effort validation of the current builder configuration.
TextModuleUpdater	setContent(String aContent, ContentFormat aContentFormat) Sets the new content for the text module with an explicit format.
TextModuleUpdater	setMarkdownContent(String aMarkdownContent) Sets the new content for the text module using Markdown format.
TextModuleUpdater	setTextModule(Node aTextModule) Sets the text module to be updated.

Method Detail

setTextModule

TextModuleUpdater setTextModule(Node aTextModule)

Sets the text module to be updated.

The node must be an existing text module sv:portlet (portlet ID "text") that is on a page. The entire content of this text module will be replaced when execute() is called.

This is a required configuration parameter.

Parameters:

aTextModule - the text module node to update, must be a valid text portlet

Returns:

This builder instance for method chaining

setMarkdownContent

TextModuleUpdater setMarkdownContent(String aMarkdownContent)

Sets the new content for the text module using Markdown format.

This is a convenience method equivalent to calling setContent(aMarkdownContent, ContentFormat.MARKDOWN). The Markdown content will be parsed and converted to rich text elements, replacing the existing content.

See ContentFormat.MARKDOWN for details on supported syntax.

Parameters:

aMarkdownContent - The new Markdown content, must not be null or empty

Returns:

This builder instance for method chaining

setContent

TextModuleUpdater setContent(String aContent,
                             ContentFormat aContentFormat)

Sets the new content for the text module with an explicit format.

This method allows you to specify the new content and its format explicitly. The content will be parsed according to the specified format and converted to rich text elements, replacing the existing content.

Parameters:

aContent - The new text content. Must not be null or empty

aContentFormat - The format of the content. Must not be null

Returns:

This builder instance for method chaining

isValid

boolean isValid()

Best-effort validation of the current builder configuration.

Checks if all required parameters are set and valid:

• Text module is not null and is a valid text portlet
• Text module's parent is a page
• Content is not null and not empty
• Content format is not null
• The page is not trashed
• The user has permission to update the page

Returns:

true if the configuration is valid, false otherwise

execute

Node execute()
      throws IllegalStateException,
             ConstraintViolationException,
             RepositoryException

Updates the text module with the new configured content.

Important: This method modifies VersionUtil.OFFLINE_VERSION of the page content and saves the changes. The operation is performed under a lock to ensure consistency. The entire existing content of the text module is replaced.

Returns:

The updated sv:portlet node

Throws:

IllegalStateException - If the configuration is invalid

ConstraintViolationException - If the targeted textModule is invalid, or the user lacks permission to update the page, or the page is trashed

RepositoryException - If something else goes wrong