com.day.cq.dam.indd

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 Summary

Modifier and Type	Method and Description
PageComponent	createComponent(java.lang.String resourceType) Convenience method to create a PageComponent for a resource type.
PageComponent	createComponent(java.lang.String resourceType, ValueMap properties) Convenience method to create a PageComponent for a resource type and the given properties.
PageComponent	createComponent(java.lang.String resourceType, ValueMap properties, java.lang.String nameHint) Factory method to create a new PageComponent.
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) Create a new Page.
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) Recreate a Page.

Method Detail

createComponent

PageComponent createComponent(java.lang.String resourceType)

Convenience method to create a PageComponent for a resource type.

Parameters:

resourceType - The PageComponents resource type

Returns:

The PageComponent

createComponent

PageComponent createComponent(java.lang.String resourceType,
                              ValueMap properties)

Convenience method to create a PageComponent for a resource type and the given properties.

Parameters:

resourceType - The PageComponents resource type

properties - The PageComponents properties

Returns:

The PageComponent

createComponent

PageComponent createComponent(java.lang.String resourceType,
                              ValueMap properties,
                              java.lang.String nameHint)

Factory method to create a new PageComponent.

Parameters:

resourceType - The PageComponents resource type

properties - The PageComponents properties

nameHint - The name hint for the PageComponent

Returns:

The PageComponent

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.