Interface CommerceCurrencyModel

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

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

This interface and its corresponding implementation com.liferay.commerce.currency.model.impl.CommerceCurrencyModelImpl 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.commerce.currency.model.impl.CommerceCurrencyImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this commerce currency.
      Returns:
      the primary key of this commerce currency
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this commerce currency.
      Parameters:
      primaryKey - the primary key of this commerce currency
    • getMvccVersion

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

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

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

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

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

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

      long getCommerceCurrencyId()
      Returns the commerce currency ID of this commerce currency.
      Returns:
      the commerce currency ID of this commerce currency
    • setCommerceCurrencyId

      void setCommerceCurrencyId(long commerceCurrencyId)
      Sets the commerce currency ID of this commerce currency.
      Parameters:
      commerceCurrencyId - the commerce currency ID of this commerce currency
    • getCompanyId

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

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

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

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

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

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

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

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

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

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

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

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this commerce currency.
      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 commerce currency
    • getCode

      @AutoEscape String getCode()
      Returns the code of this commerce currency.
      Returns:
      the code of this commerce currency
    • setCode

      void setCode(String code)
      Sets the code of this commerce currency.
      Parameters:
      code - the code of this commerce currency
    • getName

      String getName()
      Returns the name of this commerce currency.
      Returns:
      the name of this commerce currency
    • getName

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

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

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

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

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

      void setName(String name)
      Sets the name of this commerce currency.
      Parameters:
      name - the name of this commerce currency
    • setName

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

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

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

      @AutoEscape String getSymbol()
      Returns the symbol of this commerce currency.
      Returns:
      the symbol of this commerce currency
    • setSymbol

      void setSymbol(String symbol)
      Sets the symbol of this commerce currency.
      Parameters:
      symbol - the symbol of this commerce currency
    • getRate

      BigDecimal getRate()
      Returns the rate of this commerce currency.
      Returns:
      the rate of this commerce currency
    • setRate

      void setRate(BigDecimal rate)
      Sets the rate of this commerce currency.
      Parameters:
      rate - the rate of this commerce currency
    • getFormatPattern

      String getFormatPattern()
      Returns the format pattern of this commerce currency.
      Returns:
      the format pattern of this commerce currency
    • getFormatPattern

      @AutoEscape String getFormatPattern(Locale locale)
      Returns the localized format pattern of this commerce currency 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 format pattern of this commerce currency
    • getFormatPattern

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

      @AutoEscape String getFormatPattern(String languageId)
      Returns the localized format pattern of this commerce currency 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 format pattern of this commerce currency
    • getFormatPattern

      @AutoEscape String getFormatPattern(String languageId, boolean useDefault)
      Returns the localized format pattern of this commerce currency 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 format pattern of this commerce currency
    • getFormatPatternCurrentLanguageId

      @AutoEscape String getFormatPatternCurrentLanguageId()
    • getFormatPatternCurrentValue

      @AutoEscape String getFormatPatternCurrentValue()
    • getFormatPatternMap

      Map<Locale,String> getFormatPatternMap()
      Returns a map of the locales and localized format patterns of this commerce currency.
      Returns:
      the locales and localized format patterns of this commerce currency
    • setFormatPattern

      void setFormatPattern(String formatPattern)
      Sets the format pattern of this commerce currency.
      Parameters:
      formatPattern - the format pattern of this commerce currency
    • setFormatPattern

      void setFormatPattern(String formatPattern, Locale locale)
      Sets the localized format pattern of this commerce currency in the language.
      Parameters:
      formatPattern - the localized format pattern of this commerce currency
      locale - the locale of the language
    • setFormatPattern

      void setFormatPattern(String formatPattern, Locale locale, Locale defaultLocale)
      Sets the localized format pattern of this commerce currency in the language, and sets the default locale.
      Parameters:
      formatPattern - the localized format pattern of this commerce currency
      locale - the locale of the language
      defaultLocale - the default locale
    • setFormatPatternCurrentLanguageId

      void setFormatPatternCurrentLanguageId(String languageId)
    • setFormatPatternMap

      void setFormatPatternMap(Map<Locale,String> formatPatternMap)
      Sets the localized format patterns of this commerce currency from the map of locales and localized format patterns.
      Parameters:
      formatPatternMap - the locales and localized format patterns of this commerce currency
    • setFormatPatternMap

      void setFormatPatternMap(Map<Locale,String> formatPatternMap, Locale defaultLocale)
      Sets the localized format patterns of this commerce currency from the map of locales and localized format patterns, and sets the default locale.
      Parameters:
      formatPatternMap - the locales and localized format patterns of this commerce currency
      defaultLocale - the default locale
    • getMaxFractionDigits

      int getMaxFractionDigits()
      Returns the max fraction digits of this commerce currency.
      Returns:
      the max fraction digits of this commerce currency
    • setMaxFractionDigits

      void setMaxFractionDigits(int maxFractionDigits)
      Sets the max fraction digits of this commerce currency.
      Parameters:
      maxFractionDigits - the max fraction digits of this commerce currency
    • getMinFractionDigits

      int getMinFractionDigits()
      Returns the min fraction digits of this commerce currency.
      Returns:
      the min fraction digits of this commerce currency
    • setMinFractionDigits

      void setMinFractionDigits(int minFractionDigits)
      Sets the min fraction digits of this commerce currency.
      Parameters:
      minFractionDigits - the min fraction digits of this commerce currency
    • getRoundingMode

      @AutoEscape String getRoundingMode()
      Returns the rounding mode of this commerce currency.
      Returns:
      the rounding mode of this commerce currency
    • setRoundingMode

      void setRoundingMode(String roundingMode)
      Sets the rounding mode of this commerce currency.
      Parameters:
      roundingMode - the rounding mode of this commerce currency
    • getPrimary

      boolean getPrimary()
      Returns the primary of this commerce currency.
      Returns:
      the primary of this commerce currency
    • isPrimary

      boolean isPrimary()
      Returns true if this commerce currency is primary.
      Returns:
      true if this commerce currency is primary; false otherwise
    • setPrimary

      void setPrimary(boolean primary)
      Sets whether this commerce currency is primary.
      Parameters:
      primary - the primary of this commerce currency
    • getPriority

      double getPriority()
      Returns the priority of this commerce currency.
      Returns:
      the priority of this commerce currency
    • setPriority

      void setPriority(double priority)
      Sets the priority of this commerce currency.
      Parameters:
      priority - the priority of this commerce currency
    • getActive

      boolean getActive()
      Returns the active of this commerce currency.
      Returns:
      the active of this commerce currency
    • isActive

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

      void setActive(boolean active)
      Sets whether this commerce currency is active.
      Parameters:
      active - the active of this commerce currency
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this commerce currency.
      Returns:
      the last publish date of this commerce currency
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this commerce currency.
      Parameters:
      lastPublishDate - the last publish date of this commerce currency
    • 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

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

      default String toXmlString()