org.exoplatform.services.cms.views

Interface ApplicationTemplateManagerService

public interface ApplicationTemplateManagerService

Manages dynamic Groovy templates for the WCM-based products. All templates created by this service need to be stored in hierarchical context.
For example:
application 1
/category 1
/template 1
/template 2
/category 2

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLV_LIST_TEMPLATE_CATEGORY
static String	CLV_NAVIGATION_TEMPLATE_CATEGORY
static String	CLV_PAGINATOR_TEMPLATE_CATEGORY
static String	CLV_TEMPLATE_STORAGE_FOLDER

Method Summary

Methods

Modifier and Type	Method and Description
void	addPlugin(org.exoplatform.services.cms.views.PortletTemplatePlugin portletTemplatePlugin) Adds a plugin.
void	addTemplate(javax.jcr.Node portletTemplateHome, org.exoplatform.services.cms.views.PortletTemplatePlugin.PortletTemplateConfig config) Adds a template to the portlet template home.
List<String>	getAllManagedPortletName(String repository) Gets all portlet names that have dynamic Groovy templates managed by the service.
javax.jcr.Node	getApplicationTemplateHome(String portletName, SessionProvider provider) Gets the application template home.
Set<String>	getConfiguredAppTemplateMap(String portletName) Gets all configured templates of a given portlet.
javax.jcr.Node	getTemplateByName(String portletName, String category, String templateName, SessionProvider sessionProvider) Gets a template by its name under a given category.
javax.jcr.Node	getTemplateByPath(String templatePath, SessionProvider sessionProvider) Gets a template by its path under a given category.
List<javax.jcr.Node>	getTemplatesByCategory(String portletName, String category, SessionProvider sessionProvider) Gets templates under a given category.
void	removeTemplate(String portletName, String catgory, String templateName, SessionProvider sessionProvider) Removes a template from a given portlet.

Field Detail

CLV_PAGINATOR_TEMPLATE_CATEGORY

static final String CLV_PAGINATOR_TEMPLATE_CATEGORY

See Also:

Constant Field Values

CLV_NAVIGATION_TEMPLATE_CATEGORY

static final String CLV_NAVIGATION_TEMPLATE_CATEGORY

See Also:

Constant Field Values

CLV_LIST_TEMPLATE_CATEGORY

static final String CLV_LIST_TEMPLATE_CATEGORY

See Also:

Constant Field Values

CLV_TEMPLATE_STORAGE_FOLDER

static final String CLV_TEMPLATE_STORAGE_FOLDER

See Also:

Constant Field Values

Method Detail

addPlugin

void addPlugin(org.exoplatform.services.cms.views.PortletTemplatePlugin portletTemplatePlugin)
               throws Exception

Adds a plugin.

Parameters:

portletTemplatePlugin - The portlet template plugin to be added.

Throws:

Exception - The exception

getAllManagedPortletName

List<String> getAllManagedPortletName(String repository)
                                      throws Exception

Gets all portlet names that have dynamic Groovy templates managed by the service.

Parameters:

repository - Name of the repository.

Returns:

All managed portlet names.

Throws:

Exception - The exception

getTemplatesByCategory

List<javax.jcr.Node> getTemplatesByCategory(String portletName,
                                          String category,
                                          SessionProvider sessionProvider)
                                            throws Exception

Gets templates under a given category.

Parameters:

portletName - Name of the portet that contains the given category.

category - The given category.

sessionProvider - The session provider.

Returns:

The templates.

Throws:

Exception - The exception

getTemplateByName

javax.jcr.Node getTemplateByName(String portletName,
                               String category,
                               String templateName,
                               SessionProvider sessionProvider)
                                 throws Exception

Gets a template by its name under a given category.

Parameters:

portletName - Name of the portet that contains the given category.

category - The given category.

templateName - Name of the template.

sessionProvider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

getTemplateByPath

javax.jcr.Node getTemplateByPath(String templatePath,
                               SessionProvider sessionProvider)
                                 throws Exception

Gets a template by its path under a given category.

Parameters:

templatePath - Path of the template.

sessionProvider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

addTemplate

void addTemplate(javax.jcr.Node portletTemplateHome,
               org.exoplatform.services.cms.views.PortletTemplatePlugin.PortletTemplateConfig config)
                 throws Exception

Adds a template to the portlet template home.

Parameters:

portletTemplateHome - The portlet template home.

config - Configuration of the portlet template.

Throws:

Exception - The exception

removeTemplate

void removeTemplate(String portletName,
                  String catgory,
                  String templateName,
                  SessionProvider sessionProvider)
                    throws Exception

Removes a template from a given portlet.

Parameters:

portletName - Name of the given portlet.

catgory - Category of the template which needs to be removed.

templateName - Name of the removed template.

sessionProvider - The session provider.

Throws:

Exception - The exception

getApplicationTemplateHome

javax.jcr.Node getApplicationTemplateHome(String portletName,
                                        SessionProvider provider)
                                          throws Exception

Gets the application template home.

Parameters:

portletName - Name of the portlet.

provider - The session provider.

Returns:

The application template home.

Throws:

Exception - The exception

getConfiguredAppTemplateMap

Set<String> getConfiguredAppTemplateMap(String portletName)

Gets all configured templates of a given portlet.

Parameters:

portletName - Name of the given portlet.

Returns:

Set of configured templates.