org.jahia.api.templates

Interface JahiaTemplateManagerService

All Known Implementing Classes:

JahiaTemplateManagerService

public interface JahiaTemplateManagerService

Template and template set deployment and management service.

Method Summary

Modifier and Type	Method and Description
JahiaTemplatesPackage	getAnyDeployedTemplatePackage(String templatePackage)
List<JahiaTemplatesPackage>	getAvailableTemplatePackages() Returns a list of all available template packages.
int	getAvailableTemplatePackagesCount() Returns the number of available template packages in the registry.
List<JahiaTemplatesPackage>	getInstalledModulesForSite(String siteKey, boolean includeTemplateSet, boolean includeDirectDependencies, boolean includeTransitiveDependencies) get List of installed modules for a site.
Set<JahiaTemplatesPackage>	getModulesWithViewsForComponent(String componentName) Returns a set of all available template packages having templates for a module.
List<String>	getNonManageableModules()
List<JahiaTemplatesPackage>	getNonSystemModulePackages()
List<JahiaTemplatesPackage>	getNonSystemTemplateSetPackages()
Map<org.osgi.framework.Bundle,JahiaTemplatesPackage>	getRegisteredBundles()
JahiaTemplatesPackage	getTemplatePackage(String packageName) Returns the requested template package for the specified site or null if the package with the specified name is not registered in the repository.
JahiaTemplatesPackage	getTemplatePackageById(String moduleId) Returns the requested template package for the specified site or null if the package with the specified Id is not registered in the repository.
Map<String,JahiaTemplatesPackage>	getTemplatePackageByNodeName() Returns the lookup map for template packages by the JCR node name.
TemplatePackageRegistry	getTemplatePackageRegistry()
Set<String>	getTemplateSetNames() Returns a set of existing template sets that are available for site creation.

Method Detail

getTemplatePackageRegistry

TemplatePackageRegistry getTemplatePackageRegistry()

getNonManageableModules

List<String> getNonManageableModules()

getInstalledModulesForSite

List<JahiaTemplatesPackage> getInstalledModulesForSite(String siteKey,
                                                       boolean includeTemplateSet,
                                                       boolean includeDirectDependencies,
                                                       boolean includeTransitiveDependencies)
                                                throws JahiaException

get List of installed modules for a site.

Parameters:

siteKey - key of the site

includeTemplateSet - if true (default is false) include dependencies of the template set

includeDirectDependencies - if true (default is false) include dependencies of dependencies

includeTransitiveDependencies - if true (default is false) include all dependencies

Returns:

list of template packages

Throws:

JahiaException

getAvailableTemplatePackages

List<JahiaTemplatesPackage> getAvailableTemplatePackages()

Returns a list of all available template packages.

Returns:

a list of all available template packages

getNonSystemTemplateSetPackages

List<JahiaTemplatesPackage> getNonSystemTemplateSetPackages()

getNonSystemModulePackages

List<JahiaTemplatesPackage> getNonSystemModulePackages()

getAvailableTemplatePackagesCount

int getAvailableTemplatePackagesCount()

Returns the number of available template packages in the registry.

Returns:

the number of available template packages in the registry

getTemplatePackageById

JahiaTemplatesPackage getTemplatePackageById(String moduleId)

Returns the requested template package for the specified site or null if the package with the specified Id is not registered in the repository.

Parameters:

moduleId - the template package Id to search for

Returns:

the requested template package or null if the package with the specified Id is not registered in the repository

getModulesWithViewsForComponent

Set<JahiaTemplatesPackage> getModulesWithViewsForComponent(String componentName)

Returns a set of all available template packages having templates for a module.

Returns:

a set of all available template packages

getTemplatePackage

JahiaTemplatesPackage getTemplatePackage(String packageName)

Returns the requested template package for the specified site or null if the package with the specified name is not registered in the repository.

Parameters:

packageName - the template package name to search for

Returns:

the requested template package or null if the package with the specified name is not registered in the repository

getTemplatePackageByNodeName

Map<String,JahiaTemplatesPackage> getTemplatePackageByNodeName()

Returns the lookup map for template packages by the JCR node name.

Returns:

the lookup map for template packages by the JCR node name

getAnyDeployedTemplatePackage

JahiaTemplatesPackage getAnyDeployedTemplatePackage(String templatePackage)

getTemplateSetNames

Set<String> getTemplateSetNames()

Returns a set of existing template sets that are available for site creation.

Returns:

a set of existing template sets that are available for site creation

getRegisteredBundles

Map<org.osgi.framework.Bundle,JahiaTemplatesPackage> getRegisteredBundles()