Interface ListTypeDefinitionModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<ListTypeDefinition>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<ListTypeDefinition>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, 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
All Known Subinterfaces:
ListTypeDefinition
All Known Implementing Classes:
ListTypeDefinitionWrapper

@ProviderType public interface ListTypeDefinitionModel extends com.liferay.portal.kernel.model.BaseModel<ListTypeDefinition>, 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.StagedAuditedModel
The base model interface for the ListTypeDefinition service. Represents a row in the "ListTypeDefinition" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.list.type.model.impl.ListTypeDefinitionModelImpl 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.list.type.model.impl.ListTypeDefinitionImpl.

See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    long
    Returns the company ID of this list type definition.
    Returns the create date of this list type definition.
     
    Returns the external reference code of this list type definition.
    long
    Returns the list type definition ID of this list type definition.
    Returns the modified date of this list type definition.
    long
    Returns the mvcc version of this list type definition.
    Returns the name of this list type definition.
    getName(String languageId)
    Returns the localized name of this list type definition in the language.
    getName(String languageId, boolean useDefault)
    Returns the localized name of this list type definition 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 list type definition in the language.
    getName(Locale locale, boolean useDefault)
    Returns the localized name of this list type definition 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 list type definition.
    long
    Returns the primary key of this list type definition.
    boolean
    Returns the system of this list type definition.
    long
    Returns the user ID of this list type definition.
    Returns the user name of this list type definition.
    Returns the user uuid of this list type definition.
    Returns the uuid of this list type definition.
    boolean
    Returns true if this list type definition is system.
    void
     
    void
     
    void
    setCompanyId(long companyId)
    Sets the company ID of this list type definition.
    void
    setCreateDate(Date createDate)
    Sets the create date of this list type definition.
    void
    setExternalReferenceCode(String externalReferenceCode)
    Sets the external reference code of this list type definition.
    void
    setListTypeDefinitionId(long listTypeDefinitionId)
    Sets the list type definition ID of this list type definition.
    void
    setModifiedDate(Date modifiedDate)
    Sets the modified date of this list type definition.
    void
    setMvccVersion(long mvccVersion)
    Sets the mvcc version of this list type definition.
    void
    Sets the name of this list type definition.
    void
    setName(String name, Locale locale)
    Sets the localized name of this list type definition in the language.
    void
    setName(String name, Locale locale, Locale defaultLocale)
    Sets the localized name of this list type definition in the language, and sets the default locale.
    void
     
    void
    Sets the localized names of this list type definition from the map of locales and localized names.
    void
    setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
    Sets the localized names of this list type definition from the map of locales and localized names, and sets the default locale.
    void
    setPrimaryKey(long primaryKey)
    Sets the primary key of this list type definition.
    void
    setSystem(boolean system)
    Sets whether this list type definition is system.
    void
    setUserId(long userId)
    Sets the user ID of this list type definition.
    void
    setUserName(String userName)
    Sets the user name of this list type definition.
    void
    setUserUuid(String userUuid)
    Sets the user uuid of this list type definition.
    void
    Sets the uuid of this list type definition.
    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 list type definition.
      Returns:
      the primary key of this list type definition
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this list type definition.
      Parameters:
      primaryKey - the primary key of this list type definition
    • getMvccVersion

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

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this list type definition.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this list type definition
    • getUuid

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

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

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

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

      long getListTypeDefinitionId()
      Returns the list type definition ID of this list type definition.
      Returns:
      the list type definition ID of this list type definition
    • setListTypeDefinitionId

      void setListTypeDefinitionId(long listTypeDefinitionId)
      Sets the list type definition ID of this list type definition.
      Parameters:
      listTypeDefinitionId - the list type definition ID of this list type definition
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this list type definition.
      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 list type definition
    • getName

      String getName()
      Returns the name of this list type definition.
      Returns:
      the name of this list type definition
    • getName

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

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

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this list type definition 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 list type definition
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

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

      void setName(String name)
      Sets the name of this list type definition.
      Parameters:
      name - the name of this list type definition
    • setName

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

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

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

      boolean getSystem()
      Returns the system of this list type definition.
      Returns:
      the system of this list type definition
    • isSystem

      boolean isSystem()
      Returns true if this list type definition is system.
      Returns:
      true if this list type definition is system; false otherwise
    • setSystem

      void setSystem(boolean system)
      Sets whether this list type definition is system.
      Parameters:
      system - the system of this list type definition
    • 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

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

      default String toXmlString()