senselogic.sitevision.api.resource

Interface TemplateUtil

@Requireable(value="TemplateUtil")
public interface TemplateUtil

Template utility interface that primarily handles nodes with primary node type sv:template.

Sitevision templates comes in different flavours:

• A page template is a sv:template that can be used to create a page/article.
• A sub template is a sv:template that can only be used to create other templates.
• A collaboration group template is a sv:collaborationGroupTemplate that can be used to create collaboration groups.

See method documentation to see what specific flavours each method supports. Also see CollaborationGroupTemplateUtil when working with collaboration group templates.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getTemplateUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1_04

Author:

Mikael Wikblom

See Also:

CollaborationGroupTemplateUtil

Method Summary

Modifier and Type	Method and Description
Set<String>	getContentAreaNames(Node aTemplate) Gets the names of the content areas in a template.
Node	getPageTemplateByName(String aPageTemplateName) Gets first found page template with a given name.
List<Node>	getPageTemplates() Gets the page templates.
Node	getTemplateByName(String aTemplateName) Gets first found template with a given name.
List<Node>	getTemplates() Gets all templates.
boolean	isPageTemplate(Node aTemplate) Whether or not a node is a page template.

Method Detail

getTemplateByName

Node getTemplateByName(String aTemplateName)

Gets first found template with a given name.

Note! This methods returns the first matching template - regardless of its type/state. It might be a collaboration group template, it might be a page template that can be used to create pages/articles of and it might be a template that is a sub-template (i.e. a template that only can be used by other templates).

• Use getPageTemplateByName(String) to get first page template.
• Use CollaborationGroupTemplateUtil.getCollaborationGroupTemplateByName(String) to get first collaboration group template.

Permission note! Only the templates that current user has PermissionUtil.Permission.READ on will be considered.

Parameters:

aTemplateName - the name of the template

Returns:

the template, or null if indeterminable (e.g. no accessible template named aTemplateName could be found)

getTemplates

List<Node> getTemplates()

Gets all templates.

Note! This methods returns all templates - regardless of their type/state. The result might contain collaboration group templates, it might contain page templates that can be used to create pages/articles of and it might contain templates that are sub-templates (i.e. templates that only can be used by other templates).

• Use getPageTemplates() to get all page templates.
• Use CollaborationGroupTemplateUtil.getCollaborationGroupTemplates() to get all collaboration group templates.

Permission note! The list will only contain page templates that current user has PermissionUtil.Permission.READ on.

Returns:

all accessible templates, or empty list if there are no accessible page templates.

Since:

Sitevision 4.1

getPageTemplateByName

Node getPageTemplateByName(String aPageTemplateName)

Gets first found page template with a given name.

A page template is a sv:template that can be used to create pages/articles. It typically contains one or more content areas.

Permission note! Only the page templates that current user has PermissionUtil.Permission.READ on will be considered.

Parameters:

aPageTemplateName - the name of the page template

Returns:

the page template, or null if indeterminable (e.g. no accessible page template named aPageTemplateName could be found)

Since:

Sitevision 4.1

getPageTemplates

List<Node> getPageTemplates()

Gets the page templates.

A page template is a sv:template that can be used to create pages/articles. It typically contains one or more content areas.

Permission note! The list will only contain page templates that current user has PermissionUtil.Permission.READ on.

Returns:

all accessible templates that can be used to create pages/articles, or empty list if there are no accessible page templates.

Since:

Sitevision 4.1

isPageTemplate

boolean isPageTemplate(Node aTemplate)

Whether or not a node is a page template.

A page template is a sv:template that can be used to create pages/articles. It typically contains one or more content areas.

Parameters:

aTemplate - a template

Returns:

true if aTemplate can be used to create pages/articles, false otherwise

Since:

Sitevision 4.1

getContentAreaNames

Set<String> getContentAreaNames(Node aTemplate)

Gets the names of the content areas in a template.

Parameters:

aTemplate - a template (sv:template or sv:collaborationGroupTemplate)

Returns:

the names of the content areas in aTemplate, or empty set

Since:

Sitevision 4.1