org.exoplatform.services.cms.templates

Interface TemplateService

All Known Implementing Classes:

TemplateServiceImpl

public interface TemplateService

Author:

benjaminmestrallet

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DIALOG
static String	DEFAULT_DIALOGS_PATH
static String	DEFAULT_SKIN
static String	DEFAULT_VIEW
static String	DEFAULT_VIEWS_PATH
static String	DIALOGS
static String	DOCUMENT_TEMPLATE_PROP
static String	LTR
static String	NT_UNSTRUCTURED
static String	RTL
static String	SKINS
static String	TEMPLATE_LABEL
static String[]	UNDELETABLE_TEMPLATES
static String	VIEWS

Method Summary

Modifier and Type	Method and Description
void	addContentTypeFilterPlugin(ContentTypeFilterPlugin filterPlugin) This method is used to filter types of NodeType which is added in folder.
String	addTemplate(String templateType, String nodeTypeName, String label, boolean isDocumentTemplate, String templateName, String[] roles, InputStream templateFile) Insert a new template into NodeType by giving the following parameters.
String	addTemplate(String templateType, String nodeTypeName, String label, boolean isDocumentTemplate, String templateName, String[] roles, InputStream templateFile, javax.jcr.Node templatesHome) Insert a new template into NodeType by giving the following parameters.
String	buildDialogForm(String nodeTypeName) Build string of dialog form template base on properties of nodetype.
String	buildStyleSheet(String nodeTypeName) Build string of view template form base on properties of nodetype.
String	buildViewForm(String nodeTypeName) Build string of view template form base on properties of nodetype.
String	createTemplate(javax.jcr.Node templateFolder, String name, InputStream data, String[] roles) Deprecated.
String	createTemplate(javax.jcr.Node templateFolder, String title, String templateName, InputStream data, String[] roles) Insert a template into JCR database as an nt:file node.
Set<String>	getAllConfiguredNodeTypes() gets all node types configured
List<String>	getAllDocumentNodeTypes() Get All Document NodeTypes of the current repository.
Set<String>	getAllEditedConfiguredNodeTypes() Gets all node types configured whose templates were edited.
Set<String>	getAllowanceFolderType() Get set of folder type.
javax.jcr.NodeIterator	getAllTemplatesOfNodeType(boolean isDialog, String nodeTypeName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return all teamplate of the specified NodeType.
List<String>	getCreationableContentTypes(javax.jcr.Node node) Return CreationableContent Types to the given node.
String	getDefaultTemplatePath(boolean isDialog, String nodeTypeName) Return path of default template by giving the following parameters.
List<String>	getDocumentTemplates() Get all templates is document type of the specified repository.
String	getSkinPath(String nodeTypeName, String skinName, String locale) Get path of css file which included in view template.
String	getTemplate(javax.jcr.Node template) Get a template from JCR database.
String	getTemplate(String templateType, String nodeTypeName, String templateName) Return template file of the specified node.
String	getTemplateLabel(String nodeTypeName) Return the label of the specified template by giving the following parameters.
javax.jcr.Node	getTemplateNode(String templateType, String nodeTypeName, String templateName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return template Node (Name of NodeType, Name of Template) by giving the following parameters.
String	getTemplatePath(boolean isDialog, String nodeTypeName, String templateName) Return path template of the specified node.
String	getTemplatePath(javax.jcr.Node node, boolean isDialog) Return path template of the specified node.
String	getTemplatePathByAnonymous(boolean isDialog, String nodeTypeName) Return the path public template.
String	getTemplatePathByUser(boolean isDialog, String nodeTypeName, String userName) Return the template by user.
String	getTemplateRoles(javax.jcr.Node template) Get roles from a template.
javax.jcr.Node	getTemplatesHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider) Return template home of current repository.
void	init() Get all template that is configured in XML file of current repository.
boolean	isManagedNodeType(String nodeTypeName) Return true if the given repository has document type named 'nodeTypeName'.
void	removeAllTemplateCached() Remove all templates cached.
void	removeCacheTemplate(String templatePath) Remove cache of template.
void	removeManagedNodeType(String nodeTypeName) Removes the NodeType by giving the name of NodeType.
void	removeTemplate(String templateType, String nodeTypeName, String templateName) Remove a template of NodeType by giving the following parameters.
String	updateTemplate(javax.jcr.Node template, InputStream data, String[] roles) Update a template inside JCR database.

Field Detail

DIALOGS

static final String DIALOGS

See Also:

Constant Field Values

VIEWS

static final String VIEWS

See Also:

Constant Field Values

SKINS

static final String SKINS

See Also:

Constant Field Values

DEFAULT_DIALOG

static final String DEFAULT_DIALOG

See Also:

Constant Field Values

DEFAULT_VIEW

static final String DEFAULT_VIEW

See Also:

Constant Field Values

DEFAULT_SKIN

static final String DEFAULT_SKIN

See Also:

Constant Field Values

UNDELETABLE_TEMPLATES

static final String[] UNDELETABLE_TEMPLATES

DEFAULT_DIALOGS_PATH

static final String DEFAULT_DIALOGS_PATH

See Also:

Constant Field Values

DEFAULT_VIEWS_PATH

static final String DEFAULT_VIEWS_PATH

See Also:

Constant Field Values

NT_UNSTRUCTURED

static final String NT_UNSTRUCTURED

See Also:

Constant Field Values

DOCUMENT_TEMPLATE_PROP

static final String DOCUMENT_TEMPLATE_PROP

See Also:

Constant Field Values

TEMPLATE_LABEL

static final String TEMPLATE_LABEL

See Also:

Constant Field Values

RTL

static final String RTL

See Also:

Constant Field Values

LTR

static final String LTR

See Also:

Constant Field Values

Method Detail

getDefaultTemplatePath

String getDefaultTemplatePath(boolean isDialog,
                              String nodeTypeName)

Return path of default template by giving the following parameters.

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The name of NodeType

getTemplatesHome

javax.jcr.Node getTemplatesHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                         throws Exception

Return template home of current repository.

Parameters:

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

Node

getTemplatePath

String getTemplatePath(javax.jcr.Node node,
                       boolean isDialog)
                throws Exception

Return path template of the specified node.

Parameters:

node - Node The specified node

isDialog - boolean The boolean value which specify the type of template

Throws:

Exception

See Also:

Node

getTemplatePathByAnonymous

String getTemplatePathByAnonymous(boolean isDialog,
                                  String nodeTypeName)
                           throws Exception

Return the path public template.

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

Throws:

Exception

getTemplatePathByUser

String getTemplatePathByUser(boolean isDialog,
                             String nodeTypeName,
                             String userName)
                      throws javax.jcr.RepositoryException

Return the template by user.

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

userName - String The current user

Throws:

javax.jcr.RepositoryException

See Also:

Node, Session

getTemplatePath

String getTemplatePath(boolean isDialog,
                       String nodeTypeName,
                       String templateName)
                throws Exception

Return path template of the specified node.

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The specify name of node type

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

getTemplate

String getTemplate(String templateType,
                   String nodeTypeName,
                   String templateName)
            throws Exception

Return template file of the specified node.

Parameters:

templateType - String The string value which specify the type of template

nodeTypeName - String The specify name of node type

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

addTemplate

String addTemplate(String templateType,
                   String nodeTypeName,
                   String label,
                   boolean isDocumentTemplate,
                   String templateName,
                   String[] roles,
                   InputStream templateFile)
            throws Exception

Insert a new template into NodeType by giving the following parameters.

Parameters:

templateType - The value which specify the type of template

nodeTypeName - The specify name of NodType

label - The label of the specified template

isDocumentTemplate - The boolean value which yes or no is DocumentTemplate

templateName - The name of template

roles - The roles of template

templateFile - The file of template

Throws:

Exception

See Also:

Session, Node

addTemplate

String addTemplate(String templateType,
                   String nodeTypeName,
                   String label,
                   boolean isDocumentTemplate,
                   String templateName,
                   String[] roles,
                   InputStream templateFile,
                   javax.jcr.Node templatesHome)
            throws Exception

Insert a new template into NodeType by giving the following parameters.

Parameters:

templateType - The value which specify the type of template

nodeTypeName - The specify name of NodType

label - The label of the specified template

isDocumentTemplate - The boolean value which yes or no is DocumentTemplate

templateName - The name of template

roles - The roles of template

templateFile - The file of template

templatesHome - Node

Throws:

Exception

See Also:

Session, Node

addContentTypeFilterPlugin

void addContentTypeFilterPlugin(ContentTypeFilterPlugin filterPlugin)
                         throws Exception

This method is used to filter types of NodeType which is added in folder.

Parameters:

filterPlugin - Content filer plugin

Throws:

Exception

getAllowanceFolderType

Set<String> getAllowanceFolderType()

Get set of folder type.

removeTemplate

void removeTemplate(String templateType,
                    String nodeTypeName,
                    String templateName)
             throws Exception

Remove a template of NodeType by giving the following parameters.

Parameters:

templateType - String The value which specify the type of template

nodeTypeName - String The specify name of NodType

templateName - String The name of template

Throws:

Exception

See Also:

Session, Node

isManagedNodeType

boolean isManagedNodeType(String nodeTypeName)
                   throws javax.jcr.RepositoryException

Return true if the given repository has document type named 'nodeTypeName'.

Parameters:

nodeTypeName - String The name of NodeType

Throws:

javax.jcr.RepositoryException

See Also:

SessionProvider, Session, Node

getDocumentTemplates

List<String> getDocumentTemplates()
                           throws javax.jcr.RepositoryException

Get all templates is document type of the specified repository.

Throws:

javax.jcr.RepositoryException

See Also:

Session, Node

getAllTemplatesOfNodeType

javax.jcr.NodeIterator getAllTemplatesOfNodeType(boolean isDialog,
                                                 String nodeTypeName,
                                                 org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                          throws Exception

Return all teamplate of the specified NodeType.

Parameters:

isDialog - boolean The boolean value which specify the type of template

nodeTypeName - String The name of NodeType

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

SessionProvider, Node

removeManagedNodeType

void removeManagedNodeType(String nodeTypeName)
                    throws Exception

Removes the NodeType by giving the name of NodeType.

Parameters:

nodeTypeName - String The name of NodeType

Throws:

Exception

See Also:

Session, Node

getTemplateLabel

String getTemplateLabel(String nodeTypeName)
                 throws Exception

Return the label of the specified template by giving the following parameters.

Parameters:

nodeTypeName - String The specified name of NodeType

Throws:

Exception

See Also:

SessionProvider, Node

getTemplateNode

javax.jcr.Node getTemplateNode(String templateType,
                               String nodeTypeName,
                               String templateName,
                               org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                        throws Exception

Return template Node (Name of NodeType, Name of Template) by giving the following parameters.

Parameters:

templateType - String The value which specify the type of template

nodeTypeName - String The name of NodeType

templateName - String The name of template

provider - SessionProvider The SessionProvider object is used to managed Sessions

Throws:

Exception

See Also:

SessionProvider, Node

getCreationableContentTypes

List<String> getCreationableContentTypes(javax.jcr.Node node)
                                  throws Exception

Return CreationableContent Types to the given node.

Parameters:

node - The specified node

Throws:

Exception

See Also:

Node

init

void init()
   throws Exception

Get all template that is configured in XML file of current repository.

Throws:

Exception

See Also:

TemplatePlugin

removeAllTemplateCached

void removeAllTemplateCached()

Remove all templates cached.

removeCacheTemplate

void removeCacheTemplate(String templatePath)
                  throws Exception

Remove cache of template.

Parameters:

templatePath - String jcr path of template

Throws:

Exception

getAllDocumentNodeTypes

List<String> getAllDocumentNodeTypes()
                              throws javax.jcr.PathNotFoundException,
                                     javax.jcr.RepositoryException

Get All Document NodeTypes of the current repository.

Returns:

all document nodetypes

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getSkinPath

String getSkinPath(String nodeTypeName,
                   String skinName,
                   String locale)
            throws Exception

Get path of css file which included in view template.

Parameters:

nodeTypeName - String The node type name

skinName - String The name of css file

locale - String The locale which specified by user

Returns:

String The path of css file

Throws:

Exception

buildDialogForm

String buildDialogForm(String nodeTypeName)
                throws Exception

Build string of dialog form template base on properties of nodetype.

Parameters:

nodeTypeName -

Returns:

Throws:

Exception

buildViewForm

String buildViewForm(String nodeTypeName)
              throws Exception

Build string of view template form base on properties of nodetype.

Parameters:

nodeTypeName -

Returns:

Throws:

Exception

buildStyleSheet

String buildStyleSheet(String nodeTypeName)
                throws Exception

Build string of view template form base on properties of nodetype.

Parameters:

nodeTypeName -

Returns:

Throws:

Exception

createTemplate

@Deprecated
String createTemplate(javax.jcr.Node templateFolder,
                                  String name,
                                  InputStream data,
                                  String[] roles)

Deprecated.

Insert a template into JCR database as an nt:file node. This method should be used for all the template types.

Parameters:

templateFolder - The parent node which contains the template node

name - The template's name

data - The template's data

roles - The template's roles

createTemplate

String createTemplate(javax.jcr.Node templateFolder,
                      String title,
                      String templateName,
                      InputStream data,
                      String[] roles)

Insert a template into JCR database as an nt:file node. This method should be used for all the template types.

Parameters:

templateFolder - The parent node which contains the template node

title - The template title

templateName - The template's name

data - The template's data

roles - The template's roles

updateTemplate

String updateTemplate(javax.jcr.Node template,
                      InputStream data,
                      String[] roles)

Update a template inside JCR database. This method should be used for all the template types.

Parameters:

template - The template node

data - The template's data

roles - The template's roles

getTemplate

String getTemplate(javax.jcr.Node template)

Get a template from JCR database. This method should be used for all the template types.

Parameters:

template - The template node

getTemplateRoles

String getTemplateRoles(javax.jcr.Node template)

Get roles from a template. This method should be used for all the template types.

Parameters:

template - The template node

getAllConfiguredNodeTypes

Set<String> getAllConfiguredNodeTypes()

gets all node types configured

Returns:

getAllEditedConfiguredNodeTypes

Set<String> getAllEditedConfiguredNodeTypes()
                                     throws Exception

Gets all node types configured whose templates were edited.

Returns:

list of String

Throws:

Exception