com.liferay.dynamic.data.mapping.service

Interface DDMTemplateService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseService

All Known Implementing Classes:

DDMTemplateServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDMTemplateService
extends com.liferay.portal.kernel.service.BaseService

Provides the remote service interface for DDMTemplate. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

DDMTemplateServiceUtil, com.liferay.dynamic.data.mapping.service.base.DDMTemplateServiceBaseImpl, com.liferay.dynamic.data.mapping.service.impl.DDMTemplateServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
DDMTemplate	addTemplate(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 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.
DDMTemplate	copyTemplate(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 templateId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
java.util.List<DDMTemplate>	copyTemplates(long classNameId, long oldClassPK, long resourceClassNameId, 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.
void	deleteTemplate(long templateId) Deletes the template and its resources.
DDMTemplate	fetchTemplate(long groupId, long classNameId, java.lang.String templateKey) Returns the template matching the group and template key.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
DDMTemplate	getTemplate(long templateId) Returns the template with the ID.
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.
java.util.List<DDMTemplate>	getTemplates(long companyId, long groupId, long classNameId, long resourceClassNameId, int status)
java.util.List<DDMTemplate>	getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, boolean includeAncestorTemplates, int status)
java.util.List<DDMTemplate>	getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, int status)
java.util.List<DDMTemplate>	getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String type, int status) Returns all the templates matching the group, class name ID, class PK, resource class name ID, and type.
java.util.List<DDMTemplate>	getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, java.lang.String type, java.lang.String mode, int status)
java.util.List<DDMTemplate>	getTemplatesByClassPK(long companyId, long groupId, long classPK, long resourceClassNameId, int status) Returns all the templates matching the group, class PK, and resource class name ID.
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 and structure class name ID and all the generic templates matching the group.
int	getTemplatesByStructureClassNameIdCount(long groupId, long structureClassNameId, int status) Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.
void	revertTemplate(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, and mode, and matching the keywords in the template 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, and language.
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, and mode, 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, 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, and mode, 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 PK, name keyword, description keyword, type, mode, and language.
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, and mode, 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, and language.
DDMTemplate	updateTemplate(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 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 ID.

Method Detail

addTemplate

DDMTemplate addTemplate(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:

groupId - the primary key of the group

classNameId - the primary key of the class name for 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. Must have the ddmResource attribute to check permissions. 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

addTemplate

DDMTemplate addTemplate(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:

groupId - the primary key of the group

classNameId - the primary key of the class name for 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. Must have the ddmResource attribute to check permissions. 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

copyTemplate

DDMTemplate copyTemplate(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:

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. Must have the ddmResource attribute to check permissions. 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

copyTemplate

DDMTemplate copyTemplate(long templateId,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyTemplates

java.util.List<DDMTemplate> copyTemplates(long classNameId,
                                          long oldClassPK,
                                          long resourceClassNameId,
                                          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:

classNameId - the primary key of the class name for template's related model

oldClassPK - the primary key of the old template's related entity

resourceClassNameId - the primary key of the class name for template's resource model

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. Must have the ddmResource attribute to check permissions. 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

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

fetchTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchTemplate(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 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

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long templateId)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException

Returns the template with the ID.

Parameters:

templateId - the primary key of the template

Returns:

the template with the ID

Throws:

com.liferay.portal.kernel.exception.PortalException

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 template's related model

templateKey - the unique string identifying the template

Returns:

the matching template

Throws:

com.liferay.portal.kernel.exception.PortalException

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

Returns:

the matching template

Throws:

com.liferay.portal.kernel.exception.PortalException

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long companyId,
                                                                                                            long groupId,
                                                                                                            long classNameId,
                                                                                                            long resourceClassNameId,
                                                                                                            int status)

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long companyId,
                                                                                                            long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            long resourceClassNameId,
                                                                                                            boolean includeAncestorTemplates,
                                                                                                            int status)
                                                                                                     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 companyId,
                                                                                                            long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            long resourceClassNameId,
                                                                                                            int status)

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long companyId,
                                                                                                            long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            long resourceClassNameId,
                                                                                                            java.lang.String type,
                                                                                                            int status)

Returns all the templates matching the group, class name ID, class PK, resource class name ID, and type.

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 the template's resource model

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 companyId,
                                                                                                            long groupId,
                                                                                                            long classNameId,
                                                                                                            long classPK,
                                                                                                            long resourceClassNameId,
                                                                                                            java.lang.String type,
                                                                                                            java.lang.String mode,
                                                                                                            int status)

getTemplatesByClassPK

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByClassPK(long companyId,
                                                                                                                     long groupId,
                                                                                                                     long classPK,
                                                                                                                     long resourceClassNameId,
                                                                                                                     int status)

Returns all the templates matching the group, class PK, and resource class name ID.

Parameters:

companyId - the primary key of the template's company

groupId - the primary key of the group

classPK - the primary key of the template's related entity

resourceClassNameId - the primary key of the class name for the template's resource model

Returns:

the matching templates

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 and structure class name ID and all the generic templates matching the group.

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 (optionally 0). Specify 0 to return generic templates only.

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

getTemplatesByStructureClassNameIdCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTemplatesByStructureClassNameIdCount(long groupId,
                                                                                                               long structureClassNameId,
                                                                                                               int status)

Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.

Parameters:

groupId - the primary key of the group

structureClassNameId - the primary key of the class name for the template's related structure (optionally 0). Specify 0 to count generic templates only.

Returns:

the number of matching templates plus the number of matching generic templates

revertTemplate

void revertTemplate(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

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, and mode, 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 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.

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 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, 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 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.

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 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, and mode, 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

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.

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 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, 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

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.

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 matching templates ordered by the comparator

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, and mode, 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 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.

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, and language.

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 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.

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, and mode, 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 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.

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 PK, name keyword, description keyword, type, mode, and language.

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.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching templates

updateTemplate

DDMTemplate updateTemplate(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:

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

updateTemplate

DDMTemplate updateTemplate(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 ID.

Parameters:

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