Interface DDMStructureLayoutModel

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

@ProviderType public interface DDMStructureLayoutModel extends com.liferay.portal.kernel.model.BaseModel<DDMStructureLayout>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructureLayout>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel, com.liferay.portal.kernel.model.TypedModel
The base model interface for the DDMStructureLayout service. Represents a row in the "DDMStructureLayout" 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.DDMStructureLayoutModelImpl 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.DDMStructureLayoutImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    Returns the fully qualified class name of this ddm structure layout.
    long
    Returns the class name ID of this ddm structure layout.
    long
    Returns the company ID of this ddm structure layout.
    Returns the create date of this ddm structure layout.
    long
    Returns the ct collection ID of this ddm structure layout.
     
    Returns the definition of this ddm structure layout.
    Returns the description of this ddm structure layout.
    getDescription(String languageId)
    Returns the localized description of this ddm structure layout in the language.
    getDescription(String languageId, boolean useDefault)
    Returns the localized description of this ddm structure layout in the language, optionally using the default language if no localization exists for the requested language.
    Returns the localized description of this ddm structure layout in the language.
    getDescription(Locale locale, boolean useDefault)
    Returns the localized description of this ddm structure layout in the language, optionally using the default language if no localization exists for the requested language.
     
     
    Returns a map of the locales and localized descriptions of this ddm structure layout.
    long
    Returns the group ID of this ddm structure layout.
    Returns the modified date of this ddm structure layout.
    long
    Returns the mvcc version of this ddm structure layout.
    Returns the name of this ddm structure layout.
    getName(String languageId)
    Returns the localized name of this ddm structure layout in the language.
    getName(String languageId, boolean useDefault)
    Returns the localized name of this ddm structure layout in the language, optionally using the default language if no localization exists for the requested language.
    getName(Locale locale)
    Returns the localized name of this ddm structure layout in the language.
    getName(Locale locale, boolean useDefault)
    Returns the localized name of this ddm structure layout in the language, optionally using the default language if no localization exists for the requested language.
     
     
    Returns a map of the locales and localized names of this ddm structure layout.
    long
    Returns the primary key of this ddm structure layout.
    long
    Returns the structure layout ID of this ddm structure layout.
    Returns the structure layout key of this ddm structure layout.
    long
    Returns the structure version ID of this ddm structure layout.
    long
    Returns the user ID of this ddm structure layout.
    Returns the user name of this ddm structure layout.
    Returns the user uuid of this ddm structure layout.
    Returns the uuid of this ddm structure layout.
    void
     
    void
     
    void
    setClassName(String className)
     
    void
    setClassNameId(long classNameId)
    Sets the class name ID of this ddm structure layout.
    void
    setCompanyId(long companyId)
    Sets the company ID of this ddm structure layout.
    void
    setCreateDate(Date createDate)
    Sets the create date of this ddm structure layout.
    void
    setCtCollectionId(long ctCollectionId)
    Sets the ct collection ID of this ddm structure layout.
    void
    setDefinition(String definition)
    Sets the definition of this ddm structure layout.
    void
    setDescription(String description)
    Sets the description of this ddm structure layout.
    void
    setDescription(String description, Locale locale)
    Sets the localized description of this ddm structure layout in the language.
    void
    setDescription(String description, Locale locale, Locale defaultLocale)
    Sets the localized description of this ddm structure layout in the language, and sets the default locale.
    void
     
    void
    Sets the localized descriptions of this ddm structure layout from the map of locales and localized descriptions.
    void
    setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
    Sets the localized descriptions of this ddm structure layout from the map of locales and localized descriptions, and sets the default locale.
    void
    setGroupId(long groupId)
    Sets the group ID of this ddm structure layout.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this ddm structure layout.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this ddm structure layout.
    void
    Sets the name of this ddm structure layout.
    void
    setName(String name, Locale locale)
    Sets the localized name of this ddm structure layout in the language.
    void
    setName(String name, Locale locale, Locale defaultLocale)
    Sets the localized name of this ddm structure layout in the language, and sets the default locale.
    void
     
    void
    Sets the localized names of this ddm structure layout from the map of locales and localized names.
    void
    setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
    Sets the localized names of this ddm structure layout from the map of locales and localized names, and sets the default locale.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this ddm structure layout.
    void
    setStructureLayoutId(long structureLayoutId)
    Sets the structure layout ID of this ddm structure layout.
    void
    setStructureLayoutKey(String structureLayoutKey)
    Sets the structure layout key of this ddm structure layout.
    void
    setStructureVersionId(long structureVersionId)
    Sets the structure version ID of this ddm structure layout.
    void
    setUserId(long userId)
    Sets the user ID of this ddm structure layout.
    void
    setUserName(String userName)
    Sets the user name of this ddm structure layout.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this ddm structure layout.
    void
    Sets the uuid of this ddm structure layout.
    default String
     

    Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

    clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel

    Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

    getModelClass, getModelClassName

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

    clone, getStagedModelType
  • Method Details

    • getPrimaryKey

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

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

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

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

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

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

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

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

      long getStructureLayoutId()
      Returns the structure layout ID of this ddm structure layout.
      Returns:
      the structure layout ID of this ddm structure layout
    • setStructureLayoutId

      void setStructureLayoutId(long structureLayoutId)
      Sets the structure layout ID of this ddm structure layout.
      Parameters:
      structureLayoutId - the structure layout ID of this ddm structure layout
    • getGroupId

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      void setClassName(String className)
    • getClassNameId

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

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

      String getStructureLayoutKey()
      Returns the structure layout key of this ddm structure layout.
      Returns:
      the structure layout key of this ddm structure layout
    • setStructureLayoutKey

      void setStructureLayoutKey(String structureLayoutKey)
      Sets the structure layout key of this ddm structure layout.
      Parameters:
      structureLayoutKey - the structure layout key of this ddm structure layout
    • getStructureVersionId

      long getStructureVersionId()
      Returns the structure version ID of this ddm structure layout.
      Returns:
      the structure version ID of this ddm structure layout
    • setStructureVersionId

      void setStructureVersionId(long structureVersionId)
      Sets the structure version ID of this ddm structure layout.
      Parameters:
      structureVersionId - the structure version ID of this ddm structure layout
    • getName

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      void setDefinition(String definition)
      Sets the definition of this ddm structure layout.
      Parameters:
      definition - the definition of this ddm structure layout
    • 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

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

      default String toXmlString()