com.liferay.portlet.dynamicdatamapping.service

Interface DDMTemplateService

All Superinterfaces:

BaseService

All Known Implementing Classes:

DDMTemplateServiceWrapper

@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDMTemplateService
extends 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.

Author:

Brian Wing Shun Chan

See Also:

DDMTemplateServiceUtil, com.liferay.portlet.dynamicdatamapping.service.base.DDMTemplateServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
DDMTemplate	addTemplate(long groupId, long classNameId, 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, ServiceContext serviceContext) Adds a template.
DDMTemplate	addTemplate(long groupId, long classNameId, long classPK, 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, 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, ServiceContext serviceContext) Copies the template, creating a new template with all the values extracted from the original one.
DDMTemplate	copyTemplate(long templateId, ServiceContext serviceContext)
java.util.List<DDMTemplate>	copyTemplates(long classNameId, long classPK, long newClassPK, java.lang.String type, 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	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 includeGlobalTemplates) Returns the template matching the group and template key, optionally in the global scope.
java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId) Returns all the templates matching the group and class name ID.
java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId, long classPK) Returns all the templates matching the group, class name ID, and class PK.
java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId, long classPK, java.lang.String type) Returns all the templates matching the class name ID, class PK, type, and mode.
java.util.List<DDMTemplate>	getTemplates(long groupId, long classNameId, long classPK, java.lang.String type, java.lang.String mode)
java.util.List<DDMTemplate>	getTemplatesByClassPK(long groupId, long classPK) Returns all the templates matching the group and class PK.
java.util.List<DDMTemplate>	getTemplatesByStructureClassNameId(long groupId, long structureClassNameId, int start, int end, OrderByComparator 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) Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.
java.util.List<DDMTemplate>	search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, java.lang.String keywords, java.lang.String type, java.lang.String mode, int start, int end, OrderByComparator 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, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator, int start, int end, OrderByComparator 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, java.lang.String keywords, java.lang.String type, java.lang.String mode, int start, int end, OrderByComparator 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, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator, int start, int end, OrderByComparator 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, java.lang.String keywords, java.lang.String type, java.lang.String mode) 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, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, 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, java.lang.String keywords, java.lang.String type, java.lang.String mode) 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, java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String mode, java.lang.String language, boolean andOperator) Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language.
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
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, ServiceContext serviceContext) Updates the template matching the ID.

Method Detail

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTemplate

DDMTemplate addTemplate(long groupId,
                      long classNameId,
                      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,
                      ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

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

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.

mode - the template's mode. For more information, see DDMTemplateConstants.

language - the template's script language. For more information, see DDMTemplateConstants.

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:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

addTemplate

DDMTemplate addTemplate(long groupId,
                      long classNameId,
                      long classPK,
                      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,
                      ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

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

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.

mode - the template's mode. For more information, see DDMTemplateConstants.

language - the template's script language. For more information, see DDMTemplateConstants.

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:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

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,
                       ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

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:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

copyTemplate

DDMTemplate copyTemplate(long templateId,
                       ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

copyTemplates

java.util.List<DDMTemplate> copyTemplates(long classNameId,
                                        long classPK,
                                        long newClassPK,
                                        java.lang.String type,
                                        ServiceContext serviceContext)
                                          throws PortalException,
                                                 SystemException

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

classPK - the primary key of the original 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.

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:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

deleteTemplate

void deleteTemplate(long templateId)
                    throws PortalException,
                           SystemException

Deletes the template and its resources.

Parameters:

templateId - the primary key of the template to be deleted

Throws:

PortalException - if the user did not have permission to delete the template or if a portal exception occurred

SystemException - if a system exception occurred

fetchTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate fetchTemplate(long groupId,
                                                                 long classNameId,
                                                                 java.lang.String templateKey)
                          throws PortalException,
                                 SystemException

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:

PortalException - if the user did not have permission to view the template

SystemException - if a system exception occurred

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long templateId)
                        throws PortalException,
                               SystemException

Returns the template with the ID.

Parameters:

templateId - the primary key of the template

Returns:

the template with the ID

Throws:

PortalException - if the user did not have permission to view the template or if a matching template could not be found

SystemException - if a system exception occurred

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long groupId,
                                                               long classNameId,
                                                               java.lang.String templateKey)
                        throws PortalException,
                               SystemException

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:

PortalException - if a matching template could not be found

SystemException - if a system exception occurred

getTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMTemplate getTemplate(long groupId,
                                                               long classNameId,
                                                               java.lang.String templateKey,
                                                               boolean includeGlobalTemplates)
                        throws PortalException,
                               SystemException

Returns the template matching the group and template key, optionally in the global scope.

This method first searches in the group. If the template is still not found and includeGlobalTemplates is set to true, this method searches the global group.

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

includeGlobalTemplates - whether to include the global scope in the search

Returns:

the matching template

Throws:

PortalException - if a matching template could not be found

SystemException - if a system exception occurred

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                long classNameId)
                                         throws SystemException

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

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                long classNameId,
                                                                                long classPK)
                                         throws SystemException

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

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

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

getTemplates

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

Returns all the templates matching the 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 template's related model

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

type - the template's type. For more information, see DDMTemplateConstants.

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

getTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplates(long groupId,
                                                                                long classNameId,
                                                                                long classPK,
                                                                                java.lang.String type,
                                                                                java.lang.String mode)
                                         throws SystemException

Throws:

SystemException

getTemplatesByClassPK

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                                                                         long classPK)
                                                  throws SystemException

Returns all the 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 matching templates

Throws:

SystemException - if a system exception occurred

getTemplatesByStructureClassNameId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId,
                                                                                                      long structureClassNameId,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator orderByComparator)
                                                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

getTemplatesByStructureClassNameIdCount

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

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

Throws:

SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                          long groupId,
                                                                          long classNameId,
                                                                          long classPK,
                                                                          java.lang.String keywords,
                                                                          java.lang.String type,
                                                                          java.lang.String mode,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                   throws SystemException

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

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.

mode - the template's mode (optionally null) For more information, see DDMTemplateConstants.

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

Throws:

SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                          long groupId,
                                                                          long classNameId,
                                                                          long classPK,
                                                                          java.lang.String name,
                                                                          java.lang.String description,
                                                                          java.lang.String type,
                                                                          java.lang.String mode,
                                                                          java.lang.String language,
                                                                          boolean andOperator,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                   throws SystemException

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

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

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

Throws:

SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                          long[] groupIds,
                                                                          long[] classNameIds,
                                                                          long[] classPKs,
                                                                          java.lang.String keywords,
                                                                          java.lang.String type,
                                                                          java.lang.String mode,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                   throws SystemException

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

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.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

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

Throws:

SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMTemplate> search(long companyId,
                                                                          long[] groupIds,
                                                                          long[] classNameIds,
                                                                          long[] classPKs,
                                                                          java.lang.String name,
                                                                          java.lang.String description,
                                                                          java.lang.String type,
                                                                          java.lang.String mode,
                                                                          java.lang.String language,
                                                                          boolean andOperator,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                   throws SystemException

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

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

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

Throws:

SystemException - if a system exception occurred

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                       long groupId,
                                                       long classNameId,
                                                       long classPK,
                                                       java.lang.String keywords,
                                                       java.lang.String type,
                                                       java.lang.String mode)
                throws SystemException

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

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.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                       long groupId,
                                                       long classNameId,
                                                       long classPK,
                                                       java.lang.String name,
                                                       java.lang.String description,
                                                       java.lang.String type,
                                                       java.lang.String mode,
                                                       java.lang.String language,
                                                       boolean andOperator)
                throws SystemException

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

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

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

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                       long[] groupIds,
                                                       long[] classNameIds,
                                                       long[] classPKs,
                                                       java.lang.String keywords,
                                                       java.lang.String type,
                                                       java.lang.String mode)
                throws SystemException

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

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.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                       long[] groupIds,
                                                       long[] classNameIds,
                                                       long[] classPKs,
                                                       java.lang.String name,
                                                       java.lang.String description,
                                                       java.lang.String type,
                                                       java.lang.String mode,
                                                       java.lang.String language,
                                                       boolean andOperator)
                throws SystemException

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

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

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

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

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,
                         ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

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.

mode - the template's mode. For more information, see DDMTemplateConstants.

language - the template's script language. For more information, see DDMTemplateConstants.

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 the user did not have permission to update the template or if a portal exception occurred

SystemException - if a system exception occurred