com.atlassian.confluence.plugins.createcontent.template

Interface PluginPageTemplateHelper

All Known Implementing Classes:

DefaultPluginPageTemplateHelper

public interface PluginPageTemplateHelper

In essence this helper is responsible for serving up PageTemplate's stored inside plugins.

When a plugin page template is edited, a copy of the template is inserted into the database. This copy is returned in place of the original. This helper encapsulates this logic.

Calling this a "helper" so as not to introduce another manager that can cause confusion with PageTemplateManager. This interface is purely concerned with template retrieval (for now and into the future) so it does not make sense for it to implement PageTemplateManager which has write methods (and be vulnerable to API breakages).

Method Summary

Modifier and Type	Method and Description
com.atlassian.confluence.pages.templates.PageTemplate	getPageTemplate(ContentTemplateRef contentTemplateRef)
com.atlassian.confluence.pages.templates.PageTemplate	getPageTemplate(com.atlassian.confluence.pages.templates.PluginTemplateReference pluginTemplateReference)
List<com.atlassian.confluence.pages.templates.PageTemplate>	getPageTemplates(com.atlassian.confluence.spaces.Space space) Retrieves all templates declared inside plugins.
List<I18nPageTemplate>	getSystemPageTemplates() Retrieves all templates declared inside system plugins

Method Detail

getPageTemplate

com.atlassian.confluence.pages.templates.PageTemplate getPageTemplate(com.atlassian.confluence.pages.templates.PluginTemplateReference pluginTemplateReference)

Parameters:

pluginTemplateReference - a reference identifying the plugin template

Returns:

the customized page template if it exists, else the default template served directly from the plugin

getPageTemplate

com.atlassian.confluence.pages.templates.PageTemplate getPageTemplate(ContentTemplateRef contentTemplateRef)

getPageTemplates

List<com.atlassian.confluence.pages.templates.PageTemplate> getPageTemplates(com.atlassian.confluence.spaces.Space space)

Retrieves all templates declared inside plugins.

Additionally, this method will load all "customisations" of plugin templates that are stored in the database against:

• a space (if a space is specified)
• globally (if null is passed in for the space)

Any customised templates on the space or global level will be returned "instead of" the original plugin template.

Parameters:

space - the space (optional)

Returns:

a list of plugin PageTemplate(s). Any modified templates in the specified will be returned in place of the default template.

getSystemPageTemplates

List<I18nPageTemplate> getSystemPageTemplates()

Retrieves all templates declared inside system plugins

Additionally, this method will load all "customisations" of system plugin templates that are globally stored in the database

Any customised templates on the space or global level will be returned "instead of" the original plugin template.