Interface PageBuilder


  • public interface PageBuilder
    The PageBuilder interface.

    This interface can be used to create Pages and PageComponents. A page is basically designed as a list of optionally nested PageComponents. Use the PageBuilderFactory service to get a PageBuilder instance.

    This interface must not be implemented by clients.

    Since:
    5.5
    • Method Detail

      • createPage

        Page createPage​(java.lang.String pageRoot,
                        java.lang.String pageName,
                        java.lang.String pageTitle,
                        java.lang.String templatePath,
                        java.lang.String designPath,
                        java.util.List<PageComponent> components)
                 throws WCMException
        Create a new Page.
        Parameters:
        pageRoot - The page root
        pageName - The page name
        pageTitle - The page title
        templatePath - The path to the template to use
        designPath - The path to the design to use
        components - List of optionally nested PageComponents that make up the page.
        Returns:
        The new page.
        Throws:
        WCMException - exception caused while creating the page.
      • recreatePage

        Page recreatePage​(java.lang.String pageRoot,
                          java.lang.String pageName,
                          java.lang.String pageTitle,
                          java.lang.String templatePath,
                          java.lang.String designPath,
                          java.util.List<PageComponent> components)
                   throws WCMException
        Recreate a Page.
        Parameters:
        pageRoot - The page root
        pageName - The page name
        pageTitle - The page title
        templatePath - The path to the template to use
        designPath - The path to the design to use
        components - List of optionally nested PageComponents that make up the page.
        Returns:
        The recreated page.
        Throws:
        WCMException - exception caused while creating the page.