Interface DDMStructureModel

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

@ProviderType public interface DDMStructureModel extends com.liferay.portal.kernel.model.BaseModel<DDMStructure>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>, 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, com.liferay.portal.kernel.model.TypedModel
The base model interface for the DDMStructure service. Represents a row in the "DDMStructure" 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.DDMStructureModelImpl 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.DDMStructureImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      long getParentStructureId()
      Returns the parent structure ID of this ddm structure.
      Returns:
      the parent structure ID of this ddm structure
    • setParentStructureId

      void setParentStructureId(long parentStructureId)
      Sets the parent structure ID of this ddm structure.
      Parameters:
      parentStructureId - the parent structure ID of this ddm structure
    • getClassName

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

      void setClassName(String className)
    • getClassNameId

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

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

      String getStructureKey()
      Returns the structure key of this ddm structure.
      Returns:
      the structure key of this ddm structure
    • setStructureKey

      void setStructureKey(String structureKey)
      Sets the structure key of this ddm structure.
      Parameters:
      structureKey - the structure key of this ddm structure
    • getVersion

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @AutoEscape String getDefinition()
      Returns the definition of this ddm structure.
      Returns:
      the definition of this ddm structure
    • setDefinition

      void setDefinition(String definition)
      Sets the definition of this ddm structure.
      Parameters:
      definition - the definition of this ddm structure
    • getStorageType

      @AutoEscape String getStorageType()
      Returns the storage type of this ddm structure.
      Returns:
      the storage type of this ddm structure
    • setStorageType

      void setStorageType(String storageType)
      Sets the storage type of this ddm structure.
      Parameters:
      storageType - the storage type of this ddm structure
    • getType

      int getType()
      Returns the type of this ddm structure.
      Returns:
      the type of this ddm structure
    • setType

      void setType(int type)
      Sets the type of this ddm structure.
      Parameters:
      type - the type of this ddm structure
    • getLastPublishDate

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

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

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

      default String toXmlString()