Interface SegmentsEntryModel

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

@ProviderType public interface SegmentsEntryModel extends com.liferay.portal.kernel.model.BaseModel<SegmentsEntry>, com.liferay.portal.kernel.model.change.tracking.CTModel<SegmentsEntry>, 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 SegmentsEntry service. Represents a row in the "SegmentsEntry" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.segments.model.impl.SegmentsEntryModelImpl 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.segments.model.impl.SegmentsEntryImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

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

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

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

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

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

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

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

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

      long getSegmentsEntryId()
      Returns the segments entry ID of this segments entry.
      Returns:
      the segments entry ID of this segments entry
    • setSegmentsEntryId

      void setSegmentsEntryId(long segmentsEntryId)
      Sets the segments entry ID of this segments entry.
      Parameters:
      segmentsEntryId - the segments entry ID of this segments entry
    • getGroupId

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

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

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

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

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

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

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

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

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

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

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

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

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

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this segments entry.
      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 segments entry
    • getSegmentsEntryKey

      @AutoEscape String getSegmentsEntryKey()
      Returns the segments entry key of this segments entry.
      Returns:
      the segments entry key of this segments entry
    • setSegmentsEntryKey

      void setSegmentsEntryKey(String segmentsEntryKey)
      Sets the segments entry key of this segments entry.
      Parameters:
      segmentsEntryKey - the segments entry key of this segments entry
    • getName

      String getName()
      Returns the name of this segments entry.
      Returns:
      the name of this segments entry
    • getName

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

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

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

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

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

      void setName(String name)
      Sets the name of this segments entry.
      Parameters:
      name - the name of this segments entry
    • setName

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

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

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

      String getDescription()
      Returns the description of this segments entry.
      Returns:
      the description of this segments entry
    • getDescription

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

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

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this segments entry 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 segments entry
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

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

      void setDescription(String description)
      Sets the description of this segments entry.
      Parameters:
      description - the description of this segments entry
    • setDescription

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

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

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

      boolean getActive()
      Returns the active of this segments entry.
      Returns:
      the active of this segments entry
    • isActive

      boolean isActive()
      Returns true if this segments entry is active.
      Returns:
      true if this segments entry is active; false otherwise
    • setActive

      void setActive(boolean active)
      Sets whether this segments entry is active.
      Parameters:
      active - the active of this segments entry
    • getCriteria

      @AutoEscape String getCriteria()
      Returns the criteria of this segments entry.
      Returns:
      the criteria of this segments entry
    • setCriteria

      void setCriteria(String criteria)
      Sets the criteria of this segments entry.
      Parameters:
      criteria - the criteria of this segments entry
    • getSource

      @AutoEscape String getSource()
      Returns the source of this segments entry.
      Returns:
      the source of this segments entry
    • setSource

      void setSource(String source)
      Sets the source of this segments entry.
      Parameters:
      source - the source of this segments entry
    • getLastPublishDate

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

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

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

      default String toXmlString()