com.liferay.dynamic.data.mapping.service

Class DDMTemplateLocalServiceUtil

java.lang.Object

com.liferay.dynamic.data.mapping.service.DDMTemplateLocalServiceUtil

@ProviderType
public class DDMTemplateLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DDMTemplate. This utility wraps com.liferay.dynamic.data.mapping.service.impl.DDMTemplateLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
DDMTemplateLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DDMTemplate	addDDMTemplate(DDMTemplate ddmTemplate) Adds the ddm template to the database.
static 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.
static 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.
static void	addTemplateResources(DDMTemplate template, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the template.
static void	addTemplateResources(DDMTemplate template, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the template.
static 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.
static DDMTemplate	copyTemplate(long userId, long templateId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static 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.
static DDMTemplate	createDDMTemplate(long templateId) Creates a new ddm template with the primary key.
static DDMTemplate	deleteDDMTemplate(DDMTemplate ddmTemplate) Deletes the ddm template from the database.
static DDMTemplate	deleteDDMTemplate(long templateId) Deletes the ddm template with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static void	deleteTemplate(DDMTemplate template) Deletes the template and its resources.
static void	deleteTemplate(long templateId) Deletes the template and its resources.
static void	deleteTemplates(long groupId) Deletes all the templates of the group.
static void	deleteTemplates(long groupId, long classNameId)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static DDMTemplate	fetchDDMTemplate(long templateId)
static DDMTemplate	fetchDDMTemplateByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm template matching the UUID and group.
static DDMTemplate	fetchTemplate(long templateId) Returns the template with the primary key.
static DDMTemplate	fetchTemplate(long groupId, long classNameId, java.lang.String templateKey) Returns the template matching the group and template key.
static 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.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static DDMTemplate	getDDMTemplate(long templateId) Returns the ddm template with the primary key.
static DDMTemplate	getDDMTemplateByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm template matching the UUID and group.
static java.util.List<DDMTemplate>	getDDMTemplates(int start, int end) Returns a range of all the ddm templates.
static java.util.List<DDMTemplate>	getDDMTemplatesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the ddm templates matching the UUID and company.
static 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.
static int	getDDMTemplatesCount() Returns the number of ddm templates.
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static DDMTemplateLocalService	getService()
static DDMTemplate	getTemplate(long templateId) Returns the template with the primary key.
static DDMTemplate	getTemplate(long groupId, long classNameId, java.lang.String templateKey) Returns the template matching the group and template key.
static 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.
static DDMTemplate	getTemplateBySmallImageId(long smallImageId)
static java.util.List<DDMTemplate>	getTemplates(long classPK) Returns all the templates with the class PK.
static java.util.List<DDMTemplate>	getTemplates(long[] groupIds, long classNameId, long classPK)
static java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId) Returns all the templates matching the group and class name ID.
static java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId, long classPK) Returns all the templates matching the group, class name ID, and class PK.
static java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId, long classPK, boolean includeAncestorTemplates)
static 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.
static 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.
static java.util.List<DDMTemplate>	getTemplatesByClassPK(long[] groupIds, long classPK)
static java.util.List<DDMTemplate>	getTemplatesByClassPK(long groupId, long classPK)
static java.util.List<DDMTemplate>	getTemplatesByClassPK(long groupId, long classPK, int start, int end)
static int	getTemplatesByClassPKCount(long groupId, long classPK) Returns the number of templates matching the group and class PK.
static 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.
static 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.
static int	getTemplatesCount(long groupId) Returns the number of templates belonging to the group.
static int	getTemplatesCount(long groupId, long classNameId) Returns the number of templates matching the group and class name ID.
static int	getTemplatesCount(long groupId, long classNameId, long classPK) Returns the number of templates matching the group, class name ID, and class PK.
static void	revertTemplate(long userId, long templateId, java.lang.String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static 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.
static DDMTemplate	updateDDMTemplate(DDMTemplate ddmTemplate) Updates the ddm template in the database or adds it if it does not yet exist.
static 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.
static 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DDMTemplateLocalServiceUtil

public DDMTemplateLocalServiceUtil()

Method Detail

addDDMTemplate

public static 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

public static 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:

PortalException - if a portal exception occurred

addTemplate

public static 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:

PortalException - if a portal exception occurred

copyTemplate

public static 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

public static 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:

PortalException - if a portal exception occurred

createDDMTemplate

public static 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

public static 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

public static 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:

PortalException - if a ddm template with the primary key could not be found

fetchDDMTemplate

public static DDMTemplate fetchDDMTemplate(long templateId)

fetchDDMTemplateByUuidAndGroupId

public static 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

public static 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

public static 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:

PortalException - if a portal exception occurred

fetchTemplate

public static 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

public static 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:

PortalException - if a ddm template with the primary key could not be found

getDDMTemplateByUuidAndGroupId

public static 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:

PortalException - if a matching ddm template could not be found

getTemplate

public static 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:

PortalException - if a portal exception occurred

getTemplate

public static 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:

PortalException - if a portal exception occurred

getTemplate

public static 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:

PortalException - if a portal exception occurred

getTemplateBySmallImageId

public static DDMTemplate getTemplateBySmallImageId(long smallImageId)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDDMTemplate

public static 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

public static 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:

PortalException - if a portal exception occurred

updateTemplate

public static 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:

PortalException - if a portal exception occurred

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDDMTemplatesCount

public static int getDDMTemplatesCount()

Returns the number of ddm templates.

Returns:

the number of ddm templates

getTemplatesByClassPKCount

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

copyTemplates

public static 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:

PortalException - if a portal exception occurred

dynamicQuery

public static <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

public static <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

public static <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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static java.util.List<DDMTemplate> getTemplates(long[] groupIds,
                                                       long classNameId,
                                                       long classPK)

getTemplatesByClassPK

public static java.util.List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                                                long classPK)

getTemplatesByClassPK

public static java.util.List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                                                long classPK,
                                                                int start,
                                                                int end)

getTemplatesByClassPK

public static java.util.List<DDMTemplate> getTemplatesByClassPK(long[] groupIds,
                                                                long classPK)

getTemplatesByStructureClassNameId

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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:

PortalException

addTemplateResources

public static 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:

PortalException - if a portal exception occurred

deleteTemplate

public static 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:

PortalException - if a portal exception occurred

deleteTemplate

public static 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:

PortalException - if a portal exception occurred

deleteTemplates

public static 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:

PortalException - if a portal exception occurred

deleteTemplates

public static void deleteTemplates(long groupId,
                                   long classNameId)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

revertTemplate

public static 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

getService

public static DDMTemplateLocalService getService()