Interface DDMTemplateService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
All Known Implementing Classes:
DDMTemplateServiceWrapper

@AccessControlled @CTAware @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:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
    addTemplate(String externalReferenceCode, 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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds a template with additional parameters.
    addTemplate(String externalReferenceCode, long groupId, long classNameId, long classPK, long resourceClassNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds a template.
    copyTemplate(long sourceTemplateId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    copyTemplate(long sourceTemplateId, Map<Locale,String> nameMap, Map<Locale,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.
    copyTemplates(long classNameId, long sourceClassPK, long resourceClassNameId, long targetClassPK, 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.
    deleteTemplate(String externalReferenceCode, long groupId)
     
    fetchTemplate(long groupId, long classNameId, String templateKey)
    Returns the template matching the group and template key.
    Returns the OSGi service identifier.
    getTemplate(long templateId)
    Returns the template with the ID.
    getTemplate(long groupId, long classNameId, String templateKey)
    Returns the template matching the group and template key.
    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.
    getTemplateByExternalReferenceCode(String externalReferenceCode, long groupId)
     
    getTemplates(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
     
    getTemplates(long companyId, long groupId, long classNameId, long resourceClassNameId, int status)
     
    getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, boolean includeAncestorTemplates, int status)
     
    getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, int status)
     
    getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String type, int status)
    Returns all the templates matching the group, class name ID, class PK, resource class name ID, and type.
    getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String type, String mode, int status)
     
    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.
    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.
    int
    getTemplatesCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId)
     
    void
    revertTemplate(long templateId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, 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.
    search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, 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.
    search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, 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.
    search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, 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, String keywords, String type, 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, String name, String description, String type, String mode, 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, String keywords, String type, 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, String name, String description, String type, String mode, 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.
    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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the template matching the ID.
    updateTemplate(long templateId, long classPK, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the template matching the ID.
  • Method Details

    • addTemplate

      DDMTemplate addTemplate(String externalReferenceCode, long groupId, long classNameId, long classPK, long resourceClassNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds a template.
      Parameters:
      externalReferenceCode - the template's external reference code
      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(String externalReferenceCode, 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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds a template with additional parameters.
      Parameters:
      externalReferenceCode - the template's external reference code
      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 sourceTemplateId, Map<Locale,String> nameMap, Map<Locale,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:
      sourceTemplateId - 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 sourceTemplateId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyTemplates

      List<DDMTemplate> copyTemplates(long classNameId, long sourceClassPK, long resourceClassNameId, long targetClassPK, 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
      sourceClassPK - the primary key of the old template's related entity
      resourceClassNameId - the primary key of the class name for template's resource model
      targetClassPK - 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
    • deleteTemplate

      DDMTemplate deleteTemplate(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchTemplate

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMTemplate getTemplateByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTemplates

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMTemplate> getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, 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) List<DDMTemplate> getTemplates(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String type, String mode, int status)
    • getTemplates

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMTemplate> getTemplates(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator)
    • getTemplatesByClassPK

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getTemplatesCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId)
    • revertTemplate

      void revertTemplate(long templateId, 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) List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, 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) List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, 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) List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, 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) List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, 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, String keywords, String type, 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, String name, String description, String type, String mode, 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, String keywords, String type, 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, String name, String description, String type, String mode, 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, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, 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, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, 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