com.atlassian.confluence.pages.templates

Interface PageTemplateManager

All Known Implementing Classes:

DefaultPageTemplateManager

public interface PageTemplateManager

Method Summary

Modifier and Type	Method and Description
boolean	canCreate(PageTemplate template, PageTemplate foundTemplate) Returns if a template can be created.
PageTemplate	getGlobalPageTemplate(String name)
List	getGlobalPageTemplates()
PageTemplate	getPageTemplate(long id)
PageTemplate	getPageTemplate(PluginTemplateReference pluginTemplateReference)
PageTemplate	getPageTemplate(String name, Space space)
List	getPageTemplates(Space space)
List	getTemplateVariables(PageTemplate template)
String	insertVariables(PageTemplate template, List variables)
String	mergeVariables(PageTemplate template, List variables) Deprecated. since 4.3, replaced by mergeVariables(PageTemplate, List, String)
String	mergeVariables(PageTemplate template, List variables, String spaceKey)
void	refreshPageTemplate(PageTemplate pageTemplate)
void	removeAllPageTemplates(Space space)
void	removePageTemplate(PageTemplate page)
void	savePageTemplate(PageTemplate page, PageTemplate original)
void	setEventManager(com.atlassian.event.EventManager eventManager)

Method Detail

savePageTemplate

void savePageTemplate(PageTemplate page,
                      PageTemplate original)

refreshPageTemplate

void refreshPageTemplate(PageTemplate pageTemplate)

getPageTemplate

PageTemplate getPageTemplate(long id)

getPageTemplate

PageTemplate getPageTemplate(PluginTemplateReference pluginTemplateReference)

getPageTemplate

PageTemplate getPageTemplate(String name,
                             Space space)

getPageTemplates

List getPageTemplates(Space space)

Returns:

the list of all templates of the space

removePageTemplate

void removePageTemplate(PageTemplate page)

getTemplateVariables

List getTemplateVariables(PageTemplate template)
                   throws XhtmlException

Throws:

XhtmlException

mergeVariables

String mergeVariables(PageTemplate template,
                      List variables)
               throws XhtmlException

Deprecated. since 4.3, replaced by mergeVariables(PageTemplate, List, String)

Throws:

XhtmlException

mergeVariables

String mergeVariables(PageTemplate template,
                      List variables,
                      String spaceKey)
               throws XhtmlException

Throws:

XhtmlException

insertVariables

String insertVariables(PageTemplate template,
                       List variables)

canCreate

boolean canCreate(PageTemplate template,
                  PageTemplate foundTemplate)

Returns if a template can be created.

Parameters:

template - to be created, null if it's a new template

foundTemplate - template found in DB, null if not found

Returns:

true if the template can be created, otherwise false

getGlobalPageTemplates

List getGlobalPageTemplates()

getGlobalPageTemplate

PageTemplate getGlobalPageTemplate(String name)

setEventManager

void setEventManager(com.atlassian.event.EventManager eventManager)

removeAllPageTemplates

void removeAllPageTemplates(Space space)