Interface AssetVocabularyModel

All Superinterfaces:
AuditedModel, BaseModel<AssetVocabulary>, ClassedModel, Cloneable, Comparable<AssetVocabulary>, CTModel<AssetVocabulary>, ExternalReferenceCodeModel, GroupedModel, LocalizedModel, MVCCModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel
All Known Subinterfaces:
AssetVocabulary
All Known Implementing Classes:
AssetVocabularyWrapper

The base model interface for the AssetVocabulary service. Represents a row in the "AssetVocabulary" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl 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.portlet.asset.model.impl.AssetVocabularyImpl.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this asset vocabulary.
      Specified by:
      getPrimaryKey in interface CTModel<AssetVocabulary>
      Returns:
      the primary key of this asset vocabulary
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this asset vocabulary.
      Specified by:
      setPrimaryKey in interface CTModel<AssetVocabulary>
      Parameters:
      primaryKey - the primary key of this asset vocabulary
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this asset vocabulary.
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this asset vocabulary
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this asset vocabulary.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this asset vocabulary
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this asset vocabulary.
      Specified by:
      getCtCollectionId in interface CTModel<AssetVocabulary>
      Returns:
      the ct collection ID of this asset vocabulary
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this asset vocabulary.
      Specified by:
      setCtCollectionId in interface CTModel<AssetVocabulary>
      Parameters:
      ctCollectionId - the ct collection ID of this asset vocabulary
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this asset vocabulary.
      Specified by:
      getUuid in interface StagedModel
      Returns:
      the uuid of this asset vocabulary
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this asset vocabulary.
      Specified by:
      setUuid in interface StagedModel
      Parameters:
      uuid - the uuid of this asset vocabulary
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this asset vocabulary.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this asset vocabulary
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this asset vocabulary.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this asset vocabulary
    • getVocabularyId

      long getVocabularyId()
      Returns the vocabulary ID of this asset vocabulary.
      Returns:
      the vocabulary ID of this asset vocabulary
    • setVocabularyId

      void setVocabularyId(long vocabularyId)
      Sets the vocabulary ID of this asset vocabulary.
      Parameters:
      vocabularyId - the vocabulary ID of this asset vocabulary
    • getGroupId

      long getGroupId()
      Returns the group ID of this asset vocabulary.
      Specified by:
      getGroupId in interface GroupedModel
      Returns:
      the group ID of this asset vocabulary
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this asset vocabulary.
      Specified by:
      setGroupId in interface GroupedModel
      Parameters:
      groupId - the group ID of this asset vocabulary
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this asset vocabulary.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      Specified by:
      getCompanyId in interface StagedModel
      Returns:
      the company ID of this asset vocabulary
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this asset vocabulary.
      Specified by:
      setCompanyId in interface AuditedModel
      Specified by:
      setCompanyId in interface ShardedModel
      Specified by:
      setCompanyId in interface StagedModel
      Parameters:
      companyId - the company ID of this asset vocabulary
    • getUserId

      long getUserId()
      Returns the user ID of this asset vocabulary.
      Specified by:
      getUserId in interface AuditedModel
      Returns:
      the user ID of this asset vocabulary
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this asset vocabulary.
      Specified by:
      setUserId in interface AuditedModel
      Parameters:
      userId - the user ID of this asset vocabulary
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this asset vocabulary.
      Specified by:
      getUserUuid in interface AuditedModel
      Returns:
      the user uuid of this asset vocabulary
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this asset vocabulary.
      Specified by:
      setUserUuid in interface AuditedModel
      Parameters:
      userUuid - the user uuid of this asset vocabulary
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this asset vocabulary.
      Specified by:
      getUserName in interface AuditedModel
      Returns:
      the user name of this asset vocabulary
    • setUserName

      void setUserName(String userName)
      Sets the user name of this asset vocabulary.
      Specified by:
      setUserName in interface AuditedModel
      Parameters:
      userName - the user name of this asset vocabulary
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this asset vocabulary.
      Specified by:
      getCreateDate in interface AuditedModel
      Specified by:
      getCreateDate in interface StagedModel
      Returns:
      the create date of this asset vocabulary
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this asset vocabulary.
      Specified by:
      setCreateDate in interface AuditedModel
      Specified by:
      setCreateDate in interface StagedModel
      Parameters:
      createDate - the create date of this asset vocabulary
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this asset vocabulary.
      Specified by:
      getModifiedDate in interface AuditedModel
      Specified by:
      getModifiedDate in interface StagedModel
      Returns:
      the modified date of this asset vocabulary
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this asset vocabulary.
      Specified by:
      setModifiedDate in interface AuditedModel
      Specified by:
      setModifiedDate in interface StagedModel
      Parameters:
      modifiedDate - the modified date of this asset vocabulary
    • getName

      @AutoEscape String getName()
      Returns the name of this asset vocabulary.
      Returns:
      the name of this asset vocabulary
    • setName

      void setName(String name)
      Sets the name of this asset vocabulary.
      Parameters:
      name - the name of this asset vocabulary
    • getTitle

      String getTitle()
      Returns the title of this asset vocabulary.
      Returns:
      the title of this asset vocabulary
    • getTitle

      @AutoEscape String getTitle(Locale locale)
      Returns the localized title of this asset vocabulary 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 title of this asset vocabulary
    • getTitle

      @AutoEscape String getTitle(Locale locale, boolean useDefault)
      Returns the localized title of this asset vocabulary 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 title of this asset vocabulary. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getTitle

      @AutoEscape String getTitle(String languageId)
      Returns the localized title of this asset vocabulary 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 title of this asset vocabulary
    • getTitle

      @AutoEscape String getTitle(String languageId, boolean useDefault)
      Returns the localized title of this asset vocabulary 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 title of this asset vocabulary
    • getTitleCurrentLanguageId

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

      Map<Locale,String> getTitleMap()
      Returns a map of the locales and localized titles of this asset vocabulary.
      Returns:
      the locales and localized titles of this asset vocabulary
    • setTitle

      void setTitle(String title)
      Sets the title of this asset vocabulary.
      Parameters:
      title - the title of this asset vocabulary
    • setTitle

      void setTitle(String title, Locale locale)
      Sets the localized title of this asset vocabulary in the language.
      Parameters:
      title - the localized title of this asset vocabulary
      locale - the locale of the language
    • setTitle

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this asset vocabulary in the language, and sets the default locale.
      Parameters:
      title - the localized title of this asset vocabulary
      locale - the locale of the language
      defaultLocale - the default locale
    • setTitleCurrentLanguageId

      void setTitleCurrentLanguageId(String languageId)
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap)
      Sets the localized titles of this asset vocabulary from the map of locales and localized titles.
      Parameters:
      titleMap - the locales and localized titles of this asset vocabulary
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap, Locale defaultLocale)
      Sets the localized titles of this asset vocabulary from the map of locales and localized titles, and sets the default locale.
      Parameters:
      titleMap - the locales and localized titles of this asset vocabulary
      defaultLocale - the default locale
    • getDescription

      String getDescription()
      Returns the description of this asset vocabulary.
      Returns:
      the description of this asset vocabulary
    • getDescription

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

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

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

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

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

      void setDescription(String description)
      Sets the description of this asset vocabulary.
      Parameters:
      description - the description of this asset vocabulary
    • setDescription

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

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

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

      @AutoEscape String getSettings()
      Returns the settings of this asset vocabulary.
      Returns:
      the settings of this asset vocabulary
    • setSettings

      void setSettings(String settings)
      Sets the settings of this asset vocabulary.
      Parameters:
      settings - the settings of this asset vocabulary
    • getVisibilityType

      int getVisibilityType()
      Returns the visibility type of this asset vocabulary.
      Returns:
      the visibility type of this asset vocabulary
    • setVisibilityType

      void setVisibilityType(int visibilityType)
      Sets the visibility type of this asset vocabulary.
      Parameters:
      visibilityType - the visibility type of this asset vocabulary
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this asset vocabulary.
      Specified by:
      getLastPublishDate in interface StagedGroupedModel
      Returns:
      the last publish date of this asset vocabulary
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this asset vocabulary.
      Specified by:
      setLastPublishDate in interface StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this asset vocabulary
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • cloneWithOriginalValues

      AssetVocabulary cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<AssetVocabulary>
    • toXmlString

      default String toXmlString()