Liferay 7.0-ce-m6

com.liferay.portlet.dynamicdatamapping.service
Class DDMTemplateServiceWrapper

java.lang.Object
  extended by com.liferay.portlet.dynamicdatamapping.service.DDMTemplateServiceWrapper
All Implemented Interfaces:
BaseService, ServiceWrapper<DDMTemplateService>, DDMTemplateService

@ProviderType
public class DDMTemplateServiceWrapper
extends Object
implements DDMTemplateService, ServiceWrapper<DDMTemplateService>

Provides a wrapper for DDMTemplateService.

See Also:
DDMTemplateService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DDMTemplateServiceWrapper(DDMTemplateService ddmTemplateService)
           
 
Method Summary
 DDMTemplate addTemplate(long groupId, long classNameId, long classPK, long resourceClassNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, ServiceContext serviceContext)
          Adds a template.
 DDMTemplate addTemplate(long groupId, long classNameId, long classPK, long resourceClassNameId, String templateKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, ServiceContext serviceContext)
          Adds a template with additional parameters.
 DDMTemplate copyTemplate(long templateId, Map<Locale,String> nameMap, Map<Locale,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)
           
 List<DDMTemplate> copyTemplates(long classNameId, long oldClassPK, long resourceClassNameId, long newClassPK, 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, String templateKey)
          Returns the template matching the group and template key.
 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, String templateKey)
          Returns the template matching the group and template key.
 DDMTemplate getTemplate(long groupId, long classNameId, 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.
 List<DDMTemplate> getTemplates(long groupId, long classNameId)
          Returns all the templates matching the group and class name ID.
 List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK)
          Returns all the templates matching the group, class name ID, and class PK.
 List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK, boolean includeAncestorTemplates)
           
 List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK, String type)
          Returns all the templates matching the class name ID, class PK, type, and mode.
 List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK, String type, String mode)
           
 List<DDMTemplate> getTemplatesByClassPK(long groupId, long classPK)
          Returns all the templates matching the group and class PK.
 List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId, long structureClassNameId, int start, int end, 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)
          Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.
 DDMTemplateService getWrappedDDMTemplateService()
          Deprecated. As of 6.1.0, replaced by getWrappedService()
 DDMTemplateService getWrappedService()
           
 void revertTemplate(long templateId, String version, ServiceContext serviceContext)
           
 List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, String mode, int start, int end, 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.
 List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, 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.
 List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, String mode, int start, int end, 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.
 List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, 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, String keywords, String type, 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, long resourceClassNameId, String name, String description, String type, String mode, 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, long resourceClassNameId, String keywords, String type, 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, long resourceClassNameId, String name, String description, String type, String mode, 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(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setWrappedDDMTemplateService(DDMTemplateService ddmTemplateService)
          Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMTemplateService)
 void setWrappedService(DDMTemplateService ddmTemplateService)
           
 DDMTemplate updateTemplate(long templateId, long classPK, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, ServiceContext serviceContext)
          Updates the template matching the ID.
 DDMTemplate updateTemplate(long templateId, long classPK, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, ServiceContext serviceContext)
          Updates the template matching the ID.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDMTemplateServiceWrapper

public DDMTemplateServiceWrapper(DDMTemplateService ddmTemplateService)
Method Detail

addTemplate

public DDMTemplate addTemplate(long groupId,
                               long classNameId,
                               long classPK,
                               long resourceClassNameId,
                               Map<Locale,String> nameMap,
                               Map<Locale,String> descriptionMap,
                               String type,
                               String mode,
                               String language,
                               String script,
                               ServiceContext serviceContext)
                        throws PortalException
Adds a template.

Specified by:
addTemplate in interface DDMTemplateService
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.
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

addTemplate

public DDMTemplate addTemplate(long groupId,
                               long classNameId,
                               long classPK,
                               long resourceClassNameId,
                               String templateKey,
                               Map<Locale,String> nameMap,
                               Map<Locale,String> descriptionMap,
                               String type,
                               String mode,
                               String language,
                               String script,
                               boolean cacheable,
                               boolean smallImage,
                               String smallImageURL,
                               File smallImageFile,
                               ServiceContext serviceContext)
                        throws PortalException
Adds a template with additional parameters.

Specified by:
addTemplate in interface DDMTemplateService
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.
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

copyTemplate

public DDMTemplate copyTemplate(long templateId,
                                Map<Locale,String> nameMap,
                                Map<Locale,String> descriptionMap,
                                ServiceContext serviceContext)
                         throws 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.

Specified by:
copyTemplate in interface DDMTemplateService
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

copyTemplate

public DDMTemplate copyTemplate(long templateId,
                                ServiceContext serviceContext)
                         throws PortalException
Specified by:
copyTemplate in interface DDMTemplateService
Throws:
PortalException

copyTemplates

public List<DDMTemplate> copyTemplates(long classNameId,
                                       long oldClassPK,
                                       long resourceClassNameId,
                                       long newClassPK,
                                       String type,
                                       ServiceContext serviceContext)
                                throws 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.

Specified by:
copyTemplates in interface DDMTemplateService
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.
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

deleteTemplate

public void deleteTemplate(long templateId)
                    throws PortalException
Deletes the template and its resources.

Specified by:
deleteTemplate in interface DDMTemplateService
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

fetchTemplate

public DDMTemplate fetchTemplate(long groupId,
                                 long classNameId,
                                 String templateKey)
                          throws PortalException
Returns the template matching the group and template key.

Specified by:
fetchTemplate in interface DDMTemplateService
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

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface DDMTemplateService
Returns:
the Spring bean ID for this bean

getTemplate

public DDMTemplate getTemplate(long groupId,
                               long classNameId,
                               String templateKey)
                        throws PortalException
Returns the template matching the group and template key.

Specified by:
getTemplate in interface DDMTemplateService
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

getTemplate

public DDMTemplate getTemplate(long groupId,
                               long classNameId,
                               String templateKey,
                               boolean includeAncestorTemplates)
                        throws 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.

Specified by:
getTemplate in interface DDMTemplateService
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:
PortalException - if a matching template could not be found

getTemplate

public DDMTemplate getTemplate(long templateId)
                        throws PortalException
Returns the template with the ID.

Specified by:
getTemplate in interface DDMTemplateService
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

getTemplates

public List<DDMTemplate> getTemplates(long groupId,
                                      long classNameId)
Returns all the templates matching the group and class name ID.

Specified by:
getTemplates in interface DDMTemplateService
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

getTemplates

public List<DDMTemplate> getTemplates(long groupId,
                                      long classNameId,
                                      long classPK)
Returns all the templates matching the group, class name ID, and class PK.

Specified by:
getTemplates in interface DDMTemplateService
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

getTemplates

public List<DDMTemplate> getTemplates(long groupId,
                                      long classNameId,
                                      long classPK,
                                      boolean includeAncestorTemplates)
                               throws PortalException
Specified by:
getTemplates in interface DDMTemplateService
Throws:
PortalException

getTemplates

public List<DDMTemplate> getTemplates(long groupId,
                                      long classNameId,
                                      long classPK,
                                      String type)
Returns all the templates matching the class name ID, class PK, type, and mode.

Specified by:
getTemplates in interface DDMTemplateService
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

getTemplates

public List<DDMTemplate> getTemplates(long groupId,
                                      long classNameId,
                                      long classPK,
                                      String type,
                                      String mode)
Specified by:
getTemplates in interface DDMTemplateService

getTemplatesByClassPK

public List<DDMTemplate> getTemplatesByClassPK(long groupId,
                                               long classPK)
Returns all the templates matching the group and class PK.

Specified by:
getTemplatesByClassPK in interface DDMTemplateService
Parameters:
groupId - the primary key of the group
classPK - the primary key of the template's related entity
Returns:
the matching templates

getTemplatesByStructureClassNameId

public List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId,
                                                            long structureClassNameId,
                                                            int start,
                                                            int end,
                                                            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.

Specified by:
getTemplatesByStructureClassNameId in interface DDMTemplateService
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

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

Specified by:
getTemplatesByStructureClassNameIdCount in interface DDMTemplateService
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

public void revertTemplate(long templateId,
                           String version,
                           ServiceContext serviceContext)
                    throws PortalException
Specified by:
revertTemplate in interface DDMTemplateService
Throws:
PortalException

search

public List<DDMTemplate> search(long companyId,
                                long groupId,
                                long classNameId,
                                long classPK,
                                long resourceClassNameId,
                                String keywords,
                                String type,
                                String mode,
                                int start,
                                int end,
                                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.

Specified by:
search in interface DDMTemplateService
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.
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

search

public List<DDMTemplate> search(long companyId,
                                long groupId,
                                long classNameId,
                                long classPK,
                                long resourceClassNameId,
                                String name,
                                String description,
                                String type,
                                String mode,
                                String language,
                                boolean andOperator,
                                int start,
                                int end,
                                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.

Specified by:
search in interface DDMTemplateService
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.
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

search

public List<DDMTemplate> search(long companyId,
                                long[] groupIds,
                                long[] classNameIds,
                                long[] classPKs,
                                long resourceClassNameId,
                                String keywords,
                                String type,
                                String mode,
                                int start,
                                int end,
                                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.

Specified by:
search in interface DDMTemplateService
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.
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

search

public List<DDMTemplate> search(long companyId,
                                long[] groupIds,
                                long[] classNameIds,
                                long[] classPKs,
                                long resourceClassNameId,
                                String name,
                                String description,
                                String type,
                                String mode,
                                String language,
                                boolean andOperator,
                                int start,
                                int end,
                                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.

Specified by:
search in interface DDMTemplateService
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.
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

searchCount

public int searchCount(long companyId,
                       long groupId,
                       long classNameId,
                       long classPK,
                       long resourceClassNameId,
                       String keywords,
                       String type,
                       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.

Specified by:
searchCount in interface DDMTemplateService
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.
mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.
Returns:
the number of matching templates

searchCount

public int searchCount(long companyId,
                       long groupId,
                       long classNameId,
                       long classPK,
                       long resourceClassNameId,
                       String name,
                       String description,
                       String type,
                       String mode,
                       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.

Specified by:
searchCount in interface DDMTemplateService
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.
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

searchCount

public int searchCount(long companyId,
                       long[] groupIds,
                       long[] classNameIds,
                       long[] classPKs,
                       long resourceClassNameId,
                       String keywords,
                       String type,
                       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.

Specified by:
searchCount in interface DDMTemplateService
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.
mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.
Returns:
the number of matching templates

searchCount

public int searchCount(long companyId,
                       long[] groupIds,
                       long[] classNameIds,
                       long[] classPKs,
                       long resourceClassNameId,
                       String name,
                       String description,
                       String type,
                       String mode,
                       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.

Specified by:
searchCount in interface DDMTemplateService
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.
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

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface DDMTemplateService
Parameters:
beanIdentifier - the Spring bean ID for this bean

updateTemplate

public DDMTemplate updateTemplate(long templateId,
                                  long classPK,
                                  Map<Locale,String> nameMap,
                                  Map<Locale,String> descriptionMap,
                                  String type,
                                  String mode,
                                  String language,
                                  String script,
                                  boolean cacheable,
                                  ServiceContext serviceContext)
                           throws PortalException
Updates the template matching the ID.

Specified by:
updateTemplate in interface DDMTemplateService
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
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

updateTemplate

public DDMTemplate updateTemplate(long templateId,
                                  long classPK,
                                  Map<Locale,String> nameMap,
                                  Map<Locale,String> descriptionMap,
                                  String type,
                                  String mode,
                                  String language,
                                  String script,
                                  boolean cacheable,
                                  boolean smallImage,
                                  String smallImageURL,
                                  File smallImageFile,
                                  ServiceContext serviceContext)
                           throws PortalException
Updates the template matching the ID.

Specified by:
updateTemplate in interface DDMTemplateService
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

getWrappedDDMTemplateService

@Deprecated
public DDMTemplateService getWrappedDDMTemplateService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedDDMTemplateService

@Deprecated
public void setWrappedDDMTemplateService(DDMTemplateService ddmTemplateService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMTemplateService)


getWrappedService

public DDMTemplateService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<DDMTemplateService>

setWrappedService

public void setWrappedService(DDMTemplateService ddmTemplateService)
Specified by:
setWrappedService in interface ServiceWrapper<DDMTemplateService>

Liferay 7.0-ce-m6