Interface DDMFormInstanceModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<DDMFormInstance>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<DDMFormInstance>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>, 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
All Known Subinterfaces:
DDMFormInstance
All Known Implementing Classes:
DDMFormInstanceWrapper

@ProviderType public interface DDMFormInstanceModel extends com.liferay.portal.kernel.model.BaseModel<DDMFormInstance>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMFormInstance>, 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 DDMFormInstance service. Represents a row in the "DDMFormInstance" 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.DDMFormInstanceModelImpl 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.DDMFormInstanceImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

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

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

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

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

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

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

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

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

      long getFormInstanceId()
      Returns the form instance ID of this ddm form instance.
      Returns:
      the form instance ID of this ddm form instance
    • setFormInstanceId

      void setFormInstanceId(long formInstanceId)
      Sets the form instance ID of this ddm form instance.
      Parameters:
      formInstanceId - the form instance ID of this ddm form instance
    • getGroupId

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

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

      long getCompanyId()
      Returns the company ID of this ddm form instance.
      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 form instance
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this ddm form instance.
      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 form instance
    • getUserId

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

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

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

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

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

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

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

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

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

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

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

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

      Date getCreateDate()
      Returns the create date of this ddm form instance.
      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 form instance
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this ddm form instance.
      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 form instance
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this ddm form instance.
      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 form instance
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this ddm form instance.
      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 form instance
    • getStructureId

      long getStructureId()
      Returns the structure ID of this ddm form instance.
      Returns:
      the structure ID of this ddm form instance
    • setStructureId

      void setStructureId(long structureId)
      Sets the structure ID of this ddm form instance.
      Parameters:
      structureId - the structure ID of this ddm form instance
    • getVersion

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

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

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

      @AutoEscape String getName(Locale locale)
      Returns the localized name of this ddm form instance 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 form instance
    • getName

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this ddm form instance 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 form instance. 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 form instance 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 form instance
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this ddm form instance 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 form instance
    • 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 form instance.
      Returns:
      the locales and localized names of this ddm form instance
    • setName

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

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

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this ddm form instance in the language, and sets the default locale.
      Parameters:
      name - the localized name of this ddm form instance
      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 form instance from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this ddm form instance
    • setNameMap

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

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

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this ddm form instance 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 form instance
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this ddm form instance 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 form instance. 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 form instance 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 form instance
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this ddm form instance 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 form instance
    • 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 form instance.
      Returns:
      the locales and localized descriptions of this ddm form instance
    • setDescription

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

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

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this ddm form instance in the language, and sets the default locale.
      Parameters:
      description - the localized description of this ddm form instance
      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 form instance from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this ddm form instance
    • setDescriptionMap

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

      @AutoEscape String getSettings()
      Returns the settings of this ddm form instance.
      Returns:
      the settings of this ddm form instance
    • setSettings

      void setSettings(String settings)
      Sets the settings of this ddm form instance.
      Parameters:
      settings - the settings of this ddm form instance
    • getLastPublishDate

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

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this ddm form instance.
      Specified by:
      setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this ddm form instance
    • 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

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

      default String toXmlString()