Interface DDMTemplateModel

All Superinterfaces:
com.liferay.portal.kernel.model.AttachedModel, com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<DDMTemplate>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<DDMTemplate>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel, com.liferay.portal.kernel.model.TypedModel
All Known Subinterfaces:
DDMTemplate
All Known Implementing Classes:
DDMTemplateWrapper

@ProviderType public interface DDMTemplateModel extends com.liferay.portal.kernel.model.AttachedModel, com.liferay.portal.kernel.model.BaseModel<DDMTemplate>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
The base model interface for the DDMTemplate service. Represents a row in the "DDMTemplate" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.dynamic.data.mapping.model.impl.DDMTemplateModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.dynamic.data.mapping.model.impl.DDMTemplateImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this ddm template.
      Specified by:
      getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>
      Returns:
      the primary key of this ddm template
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this ddm template.
      Specified by:
      setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>
      Parameters:
      primaryKey - the primary key of this ddm template
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this ddm template.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Returns:
      the mvcc version of this ddm template
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this ddm template.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this ddm template
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this ddm template.
      Specified by:
      getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>
      Returns:
      the ct collection ID of this ddm template
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this ddm template.
      Specified by:
      setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMTemplate>
      Parameters:
      ctCollectionId - the ct collection ID of this ddm template
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this ddm template.
      Specified by:
      getUuid in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the uuid of this ddm template
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this ddm template.
      Specified by:
      setUuid in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      uuid - the uuid of this ddm template
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this ddm template.
      Specified by:
      getExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Returns:
      the external reference code of this ddm template
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this ddm template.
      Specified by:
      setExternalReferenceCode in interface com.liferay.portal.kernel.model.ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this ddm template
    • getTemplateId

      long getTemplateId()
      Returns the template ID of this ddm template.
      Returns:
      the template ID of this ddm template
    • setTemplateId

      void setTemplateId(long templateId)
      Sets the template ID of this ddm template.
      Parameters:
      templateId - the template ID of this ddm template
    • getGroupId

      long getGroupId()
      Returns the group ID of this ddm template.
      Specified by:
      getGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Returns:
      the group ID of this ddm template
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this ddm template.
      Specified by:
      setGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Parameters:
      groupId - the group ID of this ddm template
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this ddm template.
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the company ID of this ddm template
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this ddm template.
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      companyId - the company ID of this ddm template
    • getUserId

      long getUserId()
      Returns the user ID of this ddm template.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user ID of this ddm template
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this ddm template.
      Specified by:
      setUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userId - the user ID of this ddm template
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this ddm template.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this ddm template
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this ddm template.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userUuid - the user uuid of this ddm template
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this ddm template.
      Specified by:
      getUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user name of this ddm template
    • setUserName

      void setUserName(String userName)
      Sets the user name of this ddm template.
      Specified by:
      setUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userName - the user name of this ddm template
    • getVersionUserId

      long getVersionUserId()
      Returns the version user ID of this ddm template.
      Returns:
      the version user ID of this ddm template
    • setVersionUserId

      void setVersionUserId(long versionUserId)
      Sets the version user ID of this ddm template.
      Parameters:
      versionUserId - the version user ID of this ddm template
    • getVersionUserUuid

      String getVersionUserUuid()
      Returns the version user uuid of this ddm template.
      Returns:
      the version user uuid of this ddm template
    • setVersionUserUuid

      void setVersionUserUuid(String versionUserUuid)
      Sets the version user uuid of this ddm template.
      Parameters:
      versionUserUuid - the version user uuid of this ddm template
    • getVersionUserName

      @AutoEscape String getVersionUserName()
      Returns the version user name of this ddm template.
      Returns:
      the version user name of this ddm template
    • setVersionUserName

      void setVersionUserName(String versionUserName)
      Sets the version user name of this ddm template.
      Parameters:
      versionUserName - the version user name of this ddm template
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this ddm template.
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this ddm template
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this ddm template.
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      createDate - the create date of this ddm template
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this ddm template.
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this ddm template
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this ddm template.
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      modifiedDate - the modified date of this ddm template
    • getClassName

      String getClassName()
      Returns the fully qualified class name of this ddm template.
      Specified by:
      getClassName in interface com.liferay.portal.kernel.model.TypedModel
      Returns:
      the fully qualified class name of this ddm template
    • setClassName

      void setClassName(String className)
    • getClassNameId

      long getClassNameId()
      Returns the class name ID of this ddm template.
      Specified by:
      getClassNameId in interface com.liferay.portal.kernel.model.TypedModel
      Returns:
      the class name ID of this ddm template
    • setClassNameId

      void setClassNameId(long classNameId)
      Sets the class name ID of this ddm template.
      Specified by:
      setClassNameId in interface com.liferay.portal.kernel.model.TypedModel
      Parameters:
      classNameId - the class name ID of this ddm template
    • getClassPK

      long getClassPK()
      Returns the class pk of this ddm template.
      Specified by:
      getClassPK in interface com.liferay.portal.kernel.model.AttachedModel
      Returns:
      the class pk of this ddm template
    • setClassPK

      void setClassPK(long classPK)
      Sets the class pk of this ddm template.
      Specified by:
      setClassPK in interface com.liferay.portal.kernel.model.AttachedModel
      Parameters:
      classPK - the class pk of this ddm template
    • getResourceClassNameId

      long getResourceClassNameId()
      Returns the resource class name ID of this ddm template.
      Returns:
      the resource class name ID of this ddm template
    • setResourceClassNameId

      void setResourceClassNameId(long resourceClassNameId)
      Sets the resource class name ID of this ddm template.
      Parameters:
      resourceClassNameId - the resource class name ID of this ddm template
    • getTemplateKey

      String getTemplateKey()
      Returns the template key of this ddm template.
      Returns:
      the template key of this ddm template
    • setTemplateKey

      void setTemplateKey(String templateKey)
      Sets the template key of this ddm template.
      Parameters:
      templateKey - the template key of this ddm template
    • getVersion

      @AutoEscape String getVersion()
      Returns the version of this ddm template.
      Returns:
      the version of this ddm template
    • setVersion

      void setVersion(String version)
      Sets the version of this ddm template.
      Parameters:
      version - the version of this ddm template
    • getName

      String getName()
      Returns the name of this ddm template.
      Returns:
      the name of this ddm template
    • getName

      @AutoEscape String getName(Locale locale)
      Returns the localized name of this ddm template in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      locale - the locale of the language
      Returns:
      the localized name of this ddm template
    • getName

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this ddm template. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getName

      @AutoEscape String getName(String languageId)
      Returns the localized name of this ddm template in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized name of this ddm template
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this ddm template
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this ddm template.
      Returns:
      the locales and localized names of this ddm template
    • setName

      void setName(String name)
      Sets the name of this ddm template.
      Parameters:
      name - the name of this ddm template
    • setName

      void setName(String name, Locale locale)
      Sets the localized name of this ddm template in the language.
      Parameters:
      name - the localized name of this ddm template
      locale - the locale of the language
    • setName

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this ddm template in the language, and sets the default locale.
      Parameters:
      name - the localized name of this ddm template
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      void setNameCurrentLanguageId(String languageId)
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap)
      Sets the localized names of this ddm template from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this ddm template
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
      Sets the localized names of this ddm template from the map of locales and localized names, and sets the default locale.
      Parameters:
      nameMap - the locales and localized names of this ddm template
      defaultLocale - the default locale
    • getDescription

      String getDescription()
      Returns the description of this ddm template.
      Returns:
      the description of this ddm template
    • getDescription

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this ddm template in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      locale - the locale of the language
      Returns:
      the localized description of this ddm template
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this ddm template. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      @AutoEscape String getDescription(String languageId)
      Returns the localized description of this ddm template in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized description of this ddm template
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this ddm template in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this ddm template
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this ddm template.
      Returns:
      the locales and localized descriptions of this ddm template
    • setDescription

      void setDescription(String description)
      Sets the description of this ddm template.
      Parameters:
      description - the description of this ddm template
    • setDescription

      void setDescription(String description, Locale locale)
      Sets the localized description of this ddm template in the language.
      Parameters:
      description - the localized description of this ddm template
      locale - the locale of the language
    • setDescription

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this ddm template in the language, and sets the default locale.
      Parameters:
      description - the localized description of this ddm template
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      void setDescriptionCurrentLanguageId(String languageId)
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap)
      Sets the localized descriptions of this ddm template from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this ddm template
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
      Sets the localized descriptions of this ddm template from the map of locales and localized descriptions, and sets the default locale.
      Parameters:
      descriptionMap - the locales and localized descriptions of this ddm template
      defaultLocale - the default locale
    • getType

      @AutoEscape String getType()
      Returns the type of this ddm template.
      Returns:
      the type of this ddm template
    • setType

      void setType(String type)
      Sets the type of this ddm template.
      Parameters:
      type - the type of this ddm template
    • getMode

      @AutoEscape String getMode()
      Returns the mode of this ddm template.
      Returns:
      the mode of this ddm template
    • setMode

      void setMode(String mode)
      Sets the mode of this ddm template.
      Parameters:
      mode - the mode of this ddm template
    • getLanguage

      @AutoEscape String getLanguage()
      Returns the language of this ddm template.
      Returns:
      the language of this ddm template
    • setLanguage

      void setLanguage(String language)
      Sets the language of this ddm template.
      Parameters:
      language - the language of this ddm template
    • getScript

      @AutoEscape String getScript()
      Returns the script of this ddm template.
      Returns:
      the script of this ddm template
    • setScript

      void setScript(String script)
      Sets the script of this ddm template.
      Parameters:
      script - the script of this ddm template
    • getCacheable

      boolean getCacheable()
      Returns the cacheable of this ddm template.
      Returns:
      the cacheable of this ddm template
    • isCacheable

      boolean isCacheable()
      Returns true if this ddm template is cacheable.
      Returns:
      true if this ddm template is cacheable; false otherwise
    • setCacheable

      void setCacheable(boolean cacheable)
      Sets whether this ddm template is cacheable.
      Parameters:
      cacheable - the cacheable of this ddm template
    • getSmallImage

      boolean getSmallImage()
      Returns the small image of this ddm template.
      Returns:
      the small image of this ddm template
    • isSmallImage

      boolean isSmallImage()
      Returns true if this ddm template is small image.
      Returns:
      true if this ddm template is small image; false otherwise
    • setSmallImage

      void setSmallImage(boolean smallImage)
      Sets whether this ddm template is small image.
      Parameters:
      smallImage - the small image of this ddm template
    • getSmallImageId

      long getSmallImageId()
      Returns the small image ID of this ddm template.
      Returns:
      the small image ID of this ddm template
    • setSmallImageId

      void setSmallImageId(long smallImageId)
      Sets the small image ID of this ddm template.
      Parameters:
      smallImageId - the small image ID of this ddm template
    • getSmallImageURL

      @AutoEscape String getSmallImageURL()
      Returns the small image url of this ddm template.
      Returns:
      the small image url of this ddm template
    • setSmallImageURL

      void setSmallImageURL(String smallImageURL)
      Sets the small image url of this ddm template.
      Parameters:
      smallImageURL - the small image url of this ddm template
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this ddm template.
      Specified by:
      getLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Returns:
      the last publish date of this ddm template
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this ddm template.
      Specified by:
      setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this ddm template
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • cloneWithOriginalValues

      DDMTemplate cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<DDMTemplate>
    • toXmlString

      default String toXmlString()