com.foreach.across.modules.webcms.domain.type

Interface WebCmsDefaultComponentsService

public interface WebCmsDefaultComponentsService

Core API for creating default data as defined in the type of the object. (@see WebCmsDefaultComponentsServiceImpl)

Since:

0.0.2

Author:

Raf Ceuls

Method Summary

Modifier and Type	Method and Description
void	createDefaultComponents(WebCmsAsset<?> asset, Map<String,String> markerValues) Creates the default components for an object.
void	createDefaultComponents(WebCmsObject asset, WebCmsTypeSpecifier<?> typeSpecifier, Map<String,String> markerValues) Accepts a single WebCmsObject.

Method Detail

createDefaultComponents

void createDefaultComponents(WebCmsAsset<?> asset,
                             Map<String,String> markerValues)

Creates the default components for an object.

Parameters:

asset - The asset that will receive the generated data.

markerValues - Any marker values, specified as a map of the format ('@@marker@@', 'replace value')

See Also:

createDefaultComponents(WebCmsObject, WebCmsTypeSpecifier, Map)

createDefaultComponents

void createDefaultComponents(WebCmsObject asset,
                             WebCmsTypeSpecifier<?> typeSpecifier,
                             Map<String,String> markerValues)

Accepts a single WebCmsObject. If no WebCmsTypeSpecifier is specified, nothing happens. Otherwise retrieves the content template from said WebCmsTypeSpecifier and injects the values into the relevant parts of the WebCmsObject. Any marker values specified in it's respective parameter are used to update the components as they occur in any WebCmsComponent that is encountered.

Parameters:

asset - The asset that will receive the generated data.

typeSpecifier - The type of the asset

markerValues - Any marker values, specified as a map of the format ('@@marker@@', 'replace value')