DDMTemplateLocalService (Liferay Forms and Workflow 7.0.16 API)

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DDMTemplateLocalServiceWrapper
```
@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDMTemplateLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
```
Provides the local service interface for DDMTemplate. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

DDMTemplateLocalServiceUtil, com.liferay.dynamic.data.mapping.service.base.DDMTemplateLocalServiceBaseImpl, com.liferay.dynamic.data.mapping.service.impl.DDMTemplateLocalServiceImpl

Generated:

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DDMTemplate`	`addDDMTemplate(DDMTemplate ddmTemplate)` Adds the ddm template to the database.
`DDMTemplate`	`addTemplate(long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Adds a template.
`DDMTemplate`	addTemplate(long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String templateKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, boolean cacheable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a template with additional parameters.
`void`	`addTemplateResources(DDMTemplate template, boolean addGroupPermissions, boolean addGuestPermissions)` Adds the resources to the template.
`void`	`addTemplateResources(DDMTemplate template, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)` Adds the model resources with the permissions to the template.
`DDMTemplate`	`copyTemplate(long userId, long templateId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Copies the template, creating a new template with all the values extracted from the original one.
`DDMTemplate`	`copyTemplate(long userId, long templateId, com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`java.util.List<DDMTemplate>`	`copyTemplates(long userId, long classNameId, long oldClassPK, long newClassPK, java.lang.String type, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Copies all the templates matching the class name ID, class PK, and type.
`DDMTemplate`	`createDDMTemplate(long templateId)` Creates a new ddm template with the primary key.
`DDMTemplate`	`deleteDDMTemplate(DDMTemplate ddmTemplate)` Deletes the ddm template from the database.
`DDMTemplate`	`deleteDDMTemplate(long templateId)` Deletes the ddm template with the primary key from the database.
`com.liferay.portal.kernel.model.PersistedModel`	`deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)`
`void`	`deleteTemplate(DDMTemplate template)` Deletes the template and its resources.
`void`	`deleteTemplate(long templateId)` Deletes the template and its resources.
`void`	`deleteTemplates(long groupId)` Deletes all the templates of the group.
`void`	`deleteTemplates(long groupId, long classNameId)`
`com.liferay.portal.kernel.dao.orm.DynamicQuery`	`dynamicQuery()`
`<T> java.util.List<T>`	`dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`<T> java.util.List<T>`	`dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`<T> java.util.List<T>`	`dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`long`	`dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)` Returns the number of rows matching the dynamic query.
`long`	`dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)` Returns the number of rows matching the dynamic query.
`DDMTemplate`	`fetchDDMTemplate(long templateId)`
`DDMTemplate`	`fetchDDMTemplateByUuidAndGroupId(java.lang.String uuid, long groupId)` Returns the ddm template matching the UUID and group.
`DDMTemplate`	`fetchTemplate(long templateId)` Returns the template with the primary key.
`DDMTemplate`	`fetchTemplate(long groupId, long classNameId, java.lang.String templateKey)` Returns the template matching the group and template key.
`DDMTemplate`	`fetchTemplate(long groupId, long classNameId, java.lang.String templateKey, boolean includeAncestorTemplates)` Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
`com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery`	`getActionableDynamicQuery()`
`DDMTemplate`	`getDDMTemplate(long templateId)` Returns the ddm template with the primary key.
`DDMTemplate`	`getDDMTemplateByUuidAndGroupId(java.lang.String uuid, long groupId)` Returns the ddm template matching the UUID and group.
`java.util.List<DDMTemplate>`	`getDDMTemplates(int start, int end)` Returns a range of all the ddm templates.
`java.util.List<DDMTemplate>`	`getDDMTemplatesByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns all the ddm templates matching the UUID and company.
`java.util.List<DDMTemplate>`	`getDDMTemplatesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns a range of ddm templates matching the UUID and company.
`int`	`getDDMTemplatesCount()` Returns the number of ddm templates.
`com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery`	`getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)`
`com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`java.lang.String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`com.liferay.portal.kernel.model.PersistedModel`	`getPersistedModel(java.io.Serializable primaryKeyObj)`
`DDMTemplate`	`getTemplate(long templateId)` Returns the template with the primary key.
`DDMTemplate`	`getTemplate(long groupId, long classNameId, java.lang.String templateKey)` Returns the template matching the group and template key.
`DDMTemplate`	`getTemplate(long groupId, long classNameId, java.lang.String templateKey, boolean includeAncestorTemplates)` Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
`DDMTemplate`	`getTemplateBySmallImageId(long smallImageId)`
`java.util.List<DDMTemplate>`	`getTemplates(long classPK)` Returns all the templates with the class PK.
`java.util.List<DDMTemplate>`	`getTemplates(long[] groupIds, long classNameId, long classPK)`
`java.util.List<DDMTemplate>`	`getTemplates(long groupId, long classNameId)` Returns all the templates matching the group and class name ID.
`java.util.List<DDMTemplate>`	`getTemplates(long groupId, long classNameId, long classPK)` Returns all the templates matching the group, class name ID, and class PK.
`java.util.List<DDMTemplate>`	`getTemplates(long groupId, long classNameId, long classPK, boolean includeAncestorTemplates)`
`java.util.List<DDMTemplate>`	`getTemplates(long groupId, long classNameId, long classPK, java.lang.String type)` Returns all the templates matching the group, class name ID, class PK, and type.
`java.util.List<DDMTemplate>`	`getTemplates(long groupId, long classNameId, long classPK, java.lang.String type, java.lang.String mode)` Returns all the templates matching the group, class name ID, class PK, type, and mode.
`java.util.List<DDMTemplate>`	`getTemplatesByClassPK(long[] groupIds, long classPK)`
`java.util.List<DDMTemplate>`	`getTemplatesByClassPK(long groupId, long classPK)`
`java.util.List<DDMTemplate>`	`getTemplatesByClassPK(long groupId, long classPK, int start, int end)`
`int`	`getTemplatesByClassPKCount(long groupId, long classPK)` Returns the number of templates matching the group and class PK.
`java.util.List<DDMTemplate>`	`getTemplatesByStructureClassNameId(long groupId, long structureClassNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns an ordered range of all the templates matching the group, structure class name ID, and status.
`int`	`getTemplatesByStructureClassNameIdCount(long groupId, long structureClassNameId, int status)` Returns the number of templates matching the group, structure class name ID, and status, including Generic Templates.
`int`	`getTemplatesCount(long groupId)` Returns the number of templates belonging to the group.
`int`	`getTemplatesCount(long groupId, long classNameId)` Returns the number of templates matching the group and class name ID.
`int`	`getTemplatesCount(long groupId, long classNameId, long classPK)` Returns the number of templates matching the group, class name ID, and class PK.
`void`	`revertTemplate(long userId, long templateId, java.lang.String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`java.util.List<DDMTemplate>`	`search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, java.lang.String keywords, java.lang.String type, java.lang.String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns an ordered range of all the templates matching the group IDs, class Name IDs, class PK, type, mode, and status, and include the keywords on its names and descriptions.
`java.util.List<DDMTemplate>`	`search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, language, and status.
`java.util.List<DDMTemplate>`	`search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String keywords, java.lang.String type, java.lang.String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns an ordered range of all the templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
`java.util.List<DDMTemplate>`	`search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)` Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, status, and language.
`int`	`searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, java.lang.String keywords, java.lang.String type, java.lang.String mode, int status)` Returns the number of templates matching the group IDs, class name IDs, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
`int`	`searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, int status, boolean andOperator)` Returns the number of templates matching the group IDs, class name IDs, class PKs, name keyword, description keyword, type, mode, language, and status.
`int`	`searchCount(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String keywords, java.lang.String type, java.lang.String mode, int status)` Returns the number of templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
`int`	`searchCount(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, int status, boolean andOperator)` Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, language, and status.
`DDMTemplate`	`updateDDMTemplate(DDMTemplate ddmTemplate)` Updates the ddm template in the database or adds it if it does not yet exist.
`DDMTemplate`	`updateTemplate(long userId, long templateId, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, boolean cacheable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Updates the template matching the ID.
`DDMTemplate`	`updateTemplate(long userId, long templateId, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String type, java.lang.String mode, java.lang.String language, java.lang.String script, boolean cacheable, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Updates the template matching the primary key.

- Method Detail
  - addDDMTemplate
```
@Indexable(type=REINDEX)
DDMTemplate addDDMTemplate(DDMTemplate ddmTemplate)
```
    Adds the ddm template to the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    ddmTemplate - the ddm template
    
    Returns:
    
    the ddm template that was added
  - addTemplate
```
DDMTemplate addTemplate(long userId,
                        long groupId,
                        long classNameId,
                        long classPK,
                        long resourceClassNameId,
                        java.lang.String templateKey,
                        java.util.Map<java.util.Locale,java.lang.String> nameMap,
                        java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                        java.lang.String type,
                        java.lang.String mode,
                        java.lang.String language,
                        java.lang.String script,
                        boolean cacheable,
                        boolean smallImage,
                        java.lang.String smallImageURL,
                        java.io.File smallImageFile,
                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                 throws com.liferay.portal.kernel.exception.PortalException
```
    Adds a template with additional parameters.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    templateKey - the unique string identifying the template (optionally null)
    
    nameMap - the template's locales and localized names
    
    descriptionMap - the template's locales and localized descriptions
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    script - the template's script
    
    cacheable - whether the template is cacheable
    
    smallImage - whether the template has a small image
    
    smallImageURL - the template's small image URL (optionally null)
    
    smallImageFile - the template's small image file (optionally null)
    
    serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.
    
    Returns:
    
    the template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - addTemplate
```
DDMTemplate addTemplate(long userId,
                        long groupId,
                        long classNameId,
                        long classPK,
                        long resourceClassNameId,
                        java.util.Map<java.util.Locale,java.lang.String> nameMap,
                        java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                        java.lang.String type,
                        java.lang.String mode,
                        java.lang.String language,
                        java.lang.String script,
                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                 throws com.liferay.portal.kernel.exception.PortalException
```
    Adds a template.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    nameMap - the template's locales and localized names
    
    descriptionMap - the template's locales and localized descriptions
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    script - the template's script
    
    serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.
    
    Returns:
    
    the template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - copyTemplate
```
DDMTemplate copyTemplate(long userId,
                         long templateId,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - copyTemplate
```
DDMTemplate copyTemplate(long userId,
                         long templateId,
                         java.util.Map<java.util.Locale,java.lang.String> nameMap,
                         java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException
```
    Copies the template, creating a new template with all the values extracted from the original one. This method supports defining a new name and description.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    templateId - the primary key of the template to be copied
    
    nameMap - the new template's locales and localized names
    
    descriptionMap - the new template's locales and localized descriptions
    
    serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.
    
    Returns:
    
    the new template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - createDDMTemplate
```
DDMTemplate createDDMTemplate(long templateId)
```
    Creates a new ddm template with the primary key. Does not add the ddm template to the database.
    
    Parameters:
    
    templateId - the primary key for the new ddm template
    
    Returns:
    
    the new ddm template
  - deleteDDMTemplate
```
@Indexable(type=DELETE)
DDMTemplate deleteDDMTemplate(DDMTemplate ddmTemplate)
```
    Deletes the ddm template from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    ddmTemplate - the ddm template
    
    Returns:
    
    the ddm template that was removed
  - deleteDDMTemplate
```
@Indexable(type=DELETE)
DDMTemplate deleteDDMTemplate(long templateId)
                                               throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes the ddm template with the primary key from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    templateId - the primary key of the ddm template
    
    Returns:
    
    the ddm template that was removed
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a ddm template with the primary key could not be found
  - fetchDDMTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchDDMTemplate(long templateId)
```
  - fetchDDMTemplateByUuidAndGroupId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchDDMTemplateByUuidAndGroupId(java.lang.String uuid,
                                                                                                                long groupId)
```
    Returns the ddm template matching the UUID and group.
    
    Parameters:
    
    uuid - the ddm template's UUID
    
    groupId - the primary key of the group
    
    Returns:
    
    the matching ddm template, or null if a matching ddm template could not be found
  - fetchTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchTemplate(long groupId,
                                                                                             long classNameId,
                                                                                             java.lang.String templateKey)
```
    Returns the template matching the group and template key.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    templateKey - the unique string identifying the template
    
    Returns:
    
    the matching template, or null if a matching template could not be found
  - fetchTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchTemplate(long groupId,
                                                                                             long classNameId,
                                                                                             java.lang.String templateKey,
                                                                                             boolean includeAncestorTemplates)
                                                                                      throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
    This method first searches in the given group. If the template is still not found and includeAncestorTemplates is set to true, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    templateKey - the unique string identifying the template
    
    includeAncestorTemplates - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search
    
    Returns:
    
    the matching template, or null if a matching template could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - fetchTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchTemplate(long templateId)
```
    Returns the template with the primary key.
    
    Parameters:
    
    templateId - the primary key of the template
    
    Returns:
    
    the matching template, or null if a matching template could not be found
  - getDDMTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getDDMTemplate(long templateId)
                                                                                       throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the ddm template with the primary key.
    
    Parameters:
    
    templateId - the primary key of the ddm template
    
    Returns:
    
    the ddm template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a ddm template with the primary key could not be found
  - getDDMTemplateByUuidAndGroupId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getDDMTemplateByUuidAndGroupId(java.lang.String uuid,
                                                                                                              long groupId)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the ddm template matching the UUID and group.
    
    Parameters:
    
    uuid - the ddm template's UUID
    
    groupId - the primary key of the group
    
    Returns:
    
    the matching ddm template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a matching ddm template could not be found
  - getTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long groupId,
                                                                                           long classNameId,
                                                                                           java.lang.String templateKey)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the template matching the group and template key.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    templateKey - the unique string identifying the template
    
    Returns:
    
    the matching template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long groupId,
                                                                                           long classNameId,
                                                                                           java.lang.String templateKey,
                                                                                           boolean includeAncestorTemplates)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
    This method first searches in the group. If the template is still not found and includeAncestorTemplates is set to true, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    templateKey - the unique string identifying the template
    
    includeAncestorTemplates - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search
    
    Returns:
    
    the matching template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getTemplate
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long templateId)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the template with the primary key.
    
    Parameters:
    
    templateId - the primary key of the template
    
    Returns:
    
    the template with the primary key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getTemplateBySmallImageId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplateBySmallImageId(long smallImageId)
                                                                                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - updateDDMTemplate
```
@Indexable(type=REINDEX)
DDMTemplate updateDDMTemplate(DDMTemplate ddmTemplate)
```
    Updates the ddm template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Parameters:
    
    ddmTemplate - the ddm template
    
    Returns:
    
    the ddm template that was updated
  - updateTemplate
```
DDMTemplate updateTemplate(long userId,
                           long templateId,
                           long classPK,
                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           java.lang.String type,
                           java.lang.String mode,
                           java.lang.String language,
                           java.lang.String script,
                           boolean cacheable,
                           boolean smallImage,
                           java.lang.String smallImageURL,
                           java.io.File smallImageFile,
                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                    throws com.liferay.portal.kernel.exception.PortalException
```
    Updates the template matching the ID.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    templateId - the primary key of the template
    
    classPK - the primary key of the template's related entity
    
    nameMap - the template's new locales and localized names
    
    descriptionMap - the template's new locales and localized description
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    script - the template's script
    
    cacheable - whether the template is cacheable
    
    smallImage - whether the template has a small image
    
    smallImageURL - the template's small image URL (optionally null)
    
    smallImageFile - the template's small image file (optionally null)
    
    serviceContext - the service context to be applied. Can set the modification date.
    
    Returns:
    
    the updated template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - updateTemplate
```
DDMTemplate updateTemplate(long userId,
                           long templateId,
                           long classPK,
                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           java.lang.String type,
                           java.lang.String mode,
                           java.lang.String language,
                           java.lang.String script,
                           boolean cacheable,
                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                    throws com.liferay.portal.kernel.exception.PortalException
```
    Updates the template matching the primary key.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    templateId - the primary key of the template
    
    classPK - the primary key of the template's related entity
    
    nameMap - the template's new locales and localized names
    
    descriptionMap - the template's new locales and localized description
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    script - the template's script
    
    cacheable - whether the template is cacheable
    
    serviceContext - the service context to be applied. Can set the modification date.
    
    Returns:
    
    the updated template
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getActionableDynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
```
  - dynamicQuery
```
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
```
  - getExportActionableDynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
```
  - getIndexableActionableDynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
```
  - deletePersistedModel
```
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException
```
    Specified by:
    
    deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getPersistedModel
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException
```
    Specified by:
    
    getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getDDMTemplatesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMTemplatesCount()
```
    Returns the number of ddm templates.
    
    Returns:
    
    the number of ddm templates
  - getTemplatesByClassPKCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesByClassPKCount(long groupId,
                                                                                                  long classPK)
```
    Returns the number of templates matching the group and class PK.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classPK - the primary key of the template's related entity
    
    Returns:
    
    the number of templates belonging to the group and class PK
  - getTemplatesByStructureClassNameIdCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesByStructureClassNameIdCount(long groupId,
                                                                                                               long structureClassNameId,
                                                                                                               int status)
```
    Returns the number of templates matching the group, structure class name ID, and status, including Generic Templates.
    
    Parameters:
    
    groupId - the primary key of the group
    
    structureClassNameId - the primary key of the class name for the template's related structure
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    Returns:
    
    the number of matching templates
  - getTemplatesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesCount(long groupId)
```
    Returns the number of templates belonging to the group.
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the number of templates belonging to the group
  - getTemplatesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesCount(long groupId,
                                                                                         long classNameId)
```
    Returns the number of templates matching the group and class name ID.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    Returns:
    
    the number of matching templates
  - getTemplatesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesCount(long groupId,
                                                                                         long classNameId,
                                                                                         long classPK)
```
    Returns the number of templates matching the group, class name ID, and class PK.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    Returns:
    
    the number of matching templates
  - searchCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long groupId,
                                                                                   long classNameId,
                                                                                   long classPK,
                                                                                   long resourceClassNameId,
                                                                                   java.lang.String keywords,
                                                                                   java.lang.String type,
                                                                                   java.lang.String mode,
                                                                                   int status)
```
    Returns the number of templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    Returns:
    
    the number of matching templates
  - searchCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long groupId,
                                                                                   long classNameId,
                                                                                   long classPK,
                                                                                   long resourceClassNameId,
                                                                                   java.lang.String name,
                                                                                   java.lang.String description,
                                                                                   java.lang.String type,
                                                                                   java.lang.String mode,
                                                                                   java.lang.String language,
                                                                                   int status,
                                                                                   boolean andOperator)
```
    Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, language, and status.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    name - the name keywords (optionally null)
    
    description - the description keywords (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching templates
  - searchCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long[] groupIds,
                                                                                   long[] classNameIds,
                                                                                   long[] classPKs,
                                                                                   long resourceClassNameId,
                                                                                   java.lang.String keywords,
                                                                                   java.lang.String type,
                                                                                   java.lang.String mode,
                                                                                   int status)
```
    Returns the number of templates matching the group IDs, class name IDs, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupIds - the primary keys of the groups
    
    classNameIds - the primary keys of the entity's instance the templates are related to
    
    classPKs - the primary keys of the template's related entities
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    Returns:
    
    the number of matching templates
  - searchCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long[] groupIds,
                                                                                   long[] classNameIds,
                                                                                   long[] classPKs,
                                                                                   long resourceClassNameId,
                                                                                   java.lang.String name,
                                                                                   java.lang.String description,
                                                                                   java.lang.String type,
                                                                                   java.lang.String mode,
                                                                                   java.lang.String language,
                                                                                   int status,
                                                                                   boolean andOperator)
```
    Returns the number of templates matching the group IDs, class name IDs, class PKs, name keyword, description keyword, type, mode, language, and status.
    
    Parameters:
    
    companyId - the primary key of the templates company
    
    groupIds - the primary keys of the groups
    
    classNameIds - the primary keys of the entity's instance the templates are related to
    
    classPKs - the primary keys of the template's related entities
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    name - the name keywords (optionally null)
    
    description - the description keywords (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching templates
  - getOSGiServiceIdentifier
```
java.lang.String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Returns:
    
    the OSGi service identifier
  - copyTemplates
```
java.util.List<DDMTemplate> copyTemplates(long userId,
                                          long classNameId,
                                          long oldClassPK,
                                          long newClassPK,
                                          java.lang.String type,
                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                   throws com.liferay.portal.kernel.exception.PortalException
```
    Copies all the templates matching the class name ID, class PK, and type. This method creates new templates, extracting all the values from the old ones and updating their class PKs.
    
    Parameters:
    
    userId - the primary key of the template's creator/owner
    
    classNameId - the primary key of the class name for the template's related model
    
    oldClassPK - the primary key of the old template's related entity
    
    newClassPK - the primary key of the new template's related entity
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    serviceContext - the service context to be applied. Can set the creation date, modification date, guest permissions, and group permissions for the new templates.
    
    Returns:
    
    the new templates
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - dynamicQuery
```
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
```
    Performs a dynamic query on the database and returns the matching rows.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the matching rows
  - dynamicQuery
```
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end)
```
    Performs a dynamic query on the database and returns a range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    Returns:
    
    the range of matching rows
  - dynamicQuery
```
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
```
    Performs a dynamic query on the database and returns an ordered range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    
    the ordered range of matching rows
  - getDDMTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getDDMTemplates(int start,
                                                                                                               int end)
```
    Returns a range of all the ddm templates.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    start - the lower bound of the range of ddm templates
    
    end - the upper bound of the range of ddm templates (not inclusive)
    
    Returns:
    
    the range of ddm templates
  - getDDMTemplatesByUuidAndCompanyId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                 long companyId)
```
    Returns all the ddm templates matching the UUID and company.
    
    Parameters:
    
    uuid - the UUID of the ddm templates
    
    companyId - the primary key of the company
    
    Returns:
    
    the matching ddm templates, or an empty list if no matches were found
  - getDDMTemplatesByUuidAndCompanyId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                 long companyId,
                                                                                                                                 int start,
                                                                                                                                 int end,
                                                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns a range of ddm templates matching the UUID and company.
    
    Parameters:
    
    uuid - the UUID of the ddm templates
    
    companyId - the primary key of the company
    
    start - the lower bound of the range of ddm templates
    
    end - the upper bound of the range of ddm templates (not inclusive)
    
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    
    the range of matching ddm templates, or an empty list if no matches were found
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long classPK)
```
    Returns all the templates with the class PK.
    
    Parameters:
    
    classPK - the primary key of the template's related entity
    
    Returns:
    
    the templates with the class PK
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                                            long classNameId)
```
    Returns all the templates matching the group and class name ID.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    Returns:
    
    the matching templates
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK)
```
    Returns all the templates matching the group, class name ID, and class PK.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    Returns:
    
    the matching templates
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            boolean includeAncestorTemplates)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            java.lang.String type)
```
    Returns all the templates matching the group, class name ID, class PK, and type.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    Returns:
    
    the matching templates
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            java.lang.String type,
                                                                                                            java.lang.String mode)
```
    Returns all the templates matching the group, class name ID, class PK, type, and mode.
    
    Parameters:
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    type - the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    Returns:
    
    the matching templates
  - getTemplates
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long[] groupIds,
                                                                                                            long classNameId,
                                                                                                            long classPK)
```
  - getTemplatesByClassPK
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                                                                                                     long classPK)
```
  - getTemplatesByClassPK
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                                                                                                     long classPK,
                                                                                                                     int start,
                                                                                                                     int end)
```
  - getTemplatesByClassPK
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByClassPK(long[] groupIds,
                                                                                                                     long classPK)
```
  - getTemplatesByStructureClassNameId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId,
                                                                                                                                  long structureClassNameId,
                                                                                                                                  int status,
                                                                                                                                  int start,
                                                                                                                                  int end,
                                                                                                                                  com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns an ordered range of all the templates matching the group, structure class name ID, and status.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    
    groupId - the primary key of the group
    
    structureClassNameId - the primary key of the class name for the template's related structure
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    start - the lower bound of the range of templates to return
    
    end - the upper bound of the range of templates to return (not inclusive)
    
    orderByComparator - the comparator to order the templates (optionally null)
    
    Returns:
    
    the range of matching templates ordered by the comparator
  - search
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                                                      long groupId,
                                                                                                      long classNameId,
                                                                                                      long classPK,
                                                                                                      long resourceClassNameId,
                                                                                                      java.lang.String keywords,
                                                                                                      java.lang.String type,
                                                                                                      java.lang.String mode,
                                                                                                      int status,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns an ordered range of all the templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    start - the lower bound of the range of templates to return
    
    end - the upper bound of the range of templates to return (not inclusive)
    
    orderByComparator - the comparator to order the templates (optionally null)
    
    Returns:
    
    the range of matching templates ordered by the comparator
  - search
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                                                      long groupId,
                                                                                                      long classNameId,
                                                                                                      long classPK,
                                                                                                      long resourceClassNameId,
                                                                                                      java.lang.String name,
                                                                                                      java.lang.String description,
                                                                                                      java.lang.String type,
                                                                                                      java.lang.String mode,
                                                                                                      java.lang.String language,
                                                                                                      int status,
                                                                                                      boolean andOperator,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, status, and language.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupId - the primary key of the group
    
    classNameId - the primary key of the class name for the template's related model
    
    classPK - the primary key of the template's related entity
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    name - the name keywords (optionally null)
    
    description - the description keywords (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    andOperator - whether every field must match its keywords, or just one field
    
    start - the lower bound of the range of templates to return
    
    end - the upper bound of the range of templates to return (not inclusive)
    
    orderByComparator - the comparator to order the templates (optionally null)
    
    Returns:
    
    the range of matching templates ordered by the comparator
  - search
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                                                      long[] groupIds,
                                                                                                      long[] classNameIds,
                                                                                                      long[] classPKs,
                                                                                                      long resourceClassNameId,
                                                                                                      java.lang.String keywords,
                                                                                                      java.lang.String type,
                                                                                                      java.lang.String mode,
                                                                                                      int status,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns an ordered range of all the templates matching the group IDs, class Name IDs, class PK, type, mode, and status, and include the keywords on its names and descriptions.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupIds - the primary keys of the groups
    
    classNameIds - the primary keys of the entity's instances the templates are related to
    
    classPKs - the primary keys of the template's related entities
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    start - the lower bound of the range of templates to return
    
    end - the upper bound of the range of templates to return (not inclusive)
    
    orderByComparator - the comparator to order the templates (optionally null)
    
    Returns:
    
    the range of matching templates ordered by the comparator
  - search
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                                                      long[] groupIds,
                                                                                                      long[] classNameIds,
                                                                                                      long[] classPKs,
                                                                                                      long resourceClassNameId,
                                                                                                      java.lang.String name,
                                                                                                      java.lang.String description,
                                                                                                      java.lang.String type,
                                                                                                      java.lang.String mode,
                                                                                                      java.lang.String language,
                                                                                                      int status,
                                                                                                      boolean andOperator,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
```
    Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, language, and status.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the template's company
    
    groupIds - the primary keys of the groups
    
    classNameIds - the primary keys of the entity's instances the templates are related to
    
    classPKs - the primary keys of the template's related entities
    
    resourceClassNameId - the primary key of the class name for template's resource model
    
    name - the name keywords (optionally null)
    
    description - the description keywords (optionally null)
    
    type - the template's type (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    mode - the template's mode (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    language - the template's script language (optionally null). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.
    
    status - the template's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    start - the lower bound of the range of templates to return
    
    end - the upper bound of the range of templates to return (not inclusive)
    
    orderByComparator - the comparator to order the templates (optionally null)
    
    Returns:
    
    the range of matching templates ordered by the comparator
  - dynamicQueryCount
```
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the number of rows matching the dynamic query
  - dynamicQueryCount
```
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                       com.liferay.portal.kernel.dao.orm.Projection projection)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    projection - the projection to apply to the query
    
    Returns:
    
    the number of rows matching the dynamic query
  - addTemplateResources
```
void addTemplateResources(DDMTemplate template,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException
```
    Adds the resources to the template.
    
    Parameters:
    
    template - the template to add resources to
    
    addGroupPermissions - whether to add group permissions
    
    addGuestPermissions - whether to add guest permissions
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addTemplateResources
```
void addTemplateResources(DDMTemplate template,
                          com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException
```
    Adds the model resources with the permissions to the template.
    
    Parameters:
    
    template - the template to add resources to
    
    modelPermissions - the model permissions to be added
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteTemplate
```
@SystemEvent(type=1)
void deleteTemplate(DDMTemplate template)
                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes the template and its resources.
    
    Parameters:
    
    template - the template to be deleted
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteTemplate
```
void deleteTemplate(long templateId)
             throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes the template and its resources.
    
    Parameters:
    
    templateId - the primary key of the template to be deleted
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteTemplates
```
void deleteTemplates(long groupId)
              throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes all the templates of the group.
    
    Parameters:
    
    groupId - the primary key of the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteTemplates
```
void deleteTemplates(long groupId,
                     long classNameId)
              throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - revertTemplate
```
void revertTemplate(long userId,
                    long templateId,
                    java.lang.String version,
                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
             throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException

Interface DDMTemplateLocalService

Method Summary

Method Detail

addDDMTemplate

addTemplate

addTemplate

copyTemplate

copyTemplate

createDDMTemplate

deleteDDMTemplate

deleteDDMTemplate

fetchDDMTemplate

fetchDDMTemplateByUuidAndGroupId

fetchTemplate

fetchTemplate

fetchTemplate

getDDMTemplate

getDDMTemplateByUuidAndGroupId

getTemplate

getTemplate

getTemplate

getTemplateBySmallImageId

updateDDMTemplate

updateTemplate

updateTemplate

getActionableDynamicQuery

dynamicQuery

getExportActionableDynamicQuery

getIndexableActionableDynamicQuery

deletePersistedModel

getPersistedModel

getDDMTemplatesCount

getTemplatesByClassPKCount

getTemplatesByStructureClassNameIdCount

getTemplatesCount

getTemplatesCount

getTemplatesCount

searchCount

searchCount

searchCount

searchCount

getOSGiServiceIdentifier

copyTemplates

dynamicQuery

dynamicQuery

dynamicQuery

getDDMTemplates

getDDMTemplatesByUuidAndCompanyId

getDDMTemplatesByUuidAndCompanyId

getTemplates

getTemplates

getTemplates

getTemplates

getTemplates

getTemplates

getTemplates

getTemplatesByClassPK

getTemplatesByClassPK

getTemplatesByClassPK

getTemplatesByStructureClassNameId

search

search

search

search

dynamicQueryCount

dynamicQueryCount

addTemplateResources

addTemplateResources

deleteTemplate

deleteTemplate

deleteTemplates

deleteTemplates

revertTemplate