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 Summary
Modifier and TypeMethodDescriptionboolean
Returns the active of this commerce currency.String[]
getCode()
Returns the code of this commerce currency.long
Returns the commerce currency ID of this commerce currency.long
Returns the company ID of this commerce currency.Returns the create date of this commerce currency.Returns the external reference code of this commerce currency.Returns the format pattern of this commerce currency.getFormatPattern
(String languageId) Returns the localized format pattern of this commerce currency in the language.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.getFormatPattern
(Locale locale) Returns the localized format pattern of this commerce currency in the language.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.Returns a map of the locales and localized format patterns of this commerce currency.Returns the last publish date of this commerce currency.int
Returns the max fraction digits of this commerce currency.int
Returns the min fraction digits of this commerce currency.Returns the modified date of this commerce currency.long
Returns the mvcc version of this commerce currency.getName()
Returns the name of this commerce currency.Returns the localized name of this commerce currency in the language.Returns the localized name of this commerce currency in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this commerce currency in the language.Returns the localized name of this commerce currency 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 commerce currency.boolean
Returns the primary of this commerce currency.long
Returns the primary key of this commerce currency.double
Returns the priority of this commerce currency.getRate()
Returns the rate of this commerce currency.Returns the rounding mode of this commerce currency.Returns the symbol of this commerce currency.long
Returns the user ID of this commerce currency.Returns the user name of this commerce currency.Returns the user uuid of this commerce currency.getUuid()
Returns the uuid of this commerce currency.boolean
isActive()
Returnstrue
if this commerce currency is active.boolean
Returnstrue
if this commerce currency is primary.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setActive
(boolean active) Sets whether this commerce currency is active.void
Sets the code of this commerce currency.void
setCommerceCurrencyId
(long commerceCurrencyId) Sets the commerce currency ID of this commerce currency.void
setCompanyId
(long companyId) Sets the company ID of this commerce currency.void
setCreateDate
(Date createDate) Sets the create date of this commerce currency.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this commerce currency.void
setFormatPattern
(String formatPattern) Sets the format pattern of this commerce currency.void
setFormatPattern
(String formatPattern, Locale locale) Sets the localized format pattern of this commerce currency in the language.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.void
setFormatPatternCurrentLanguageId
(String languageId) void
setFormatPatternMap
(Map<Locale, String> formatPatternMap) Sets the localized format patterns of this commerce currency from the map of locales and localized format patterns.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.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this commerce currency.void
setMaxFractionDigits
(int maxFractionDigits) Sets the max fraction digits of this commerce currency.void
setMinFractionDigits
(int minFractionDigits) Sets the min fraction digits of this commerce currency.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this commerce currency.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this commerce currency.void
Sets the name of this commerce currency.void
Sets the localized name of this commerce currency in the language.void
Sets the localized name of this commerce currency in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this commerce currency from the map of locales and localized names.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.void
setPrimary
(boolean primary) Sets whether this commerce currency is primary.void
setPrimaryKey
(long primaryKey) Sets the primary key of this commerce currency.void
setPriority
(double priority) Sets the priority of this commerce currency.void
setRate
(BigDecimal rate) Sets the rate of this commerce currency.void
setRoundingMode
(String roundingMode) Sets the rounding mode of this commerce currency.void
Sets the symbol of this commerce currency.void
setUserId
(long userId) Sets the user ID of this commerce currency.void
setUserName
(String userName) Sets the user name of this commerce currency.void
setUserUuid
(String userUuid) Sets the user uuid of this commerce currency.void
Sets the uuid of this commerce currency.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 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 interfacecom.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 interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this commerce currency
-
getUuid
Returns the uuid of this commerce currency.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this commerce currency
-
setUuid
Sets the uuid of this commerce currency.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this commerce currency
-
getExternalReferenceCode
Returns the external reference code of this commerce currency.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this commerce currency
-
setExternalReferenceCode
Sets the external reference code of this commerce currency.- Specified by:
setExternalReferenceCode
in interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.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 interfacecom.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 interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this commerce currency
-
setUserUuid
Sets the user uuid of this commerce currency.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this commerce currency
-
getUserName
Returns the user name of this commerce currency.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this commerce currency
-
setUserName
Sets the user name of this commerce currency.- Specified by:
setUserName
in interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this commerce currency
-
setCreateDate
Sets the create date of this commerce currency.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this commerce currency
-
setModifiedDate
Sets the modified date of this commerce currency.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this commerce currency
-
getCode
Returns the code of this commerce currency.- Returns:
- the code of this commerce currency
-
setCode
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
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this commerce currency. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this commerce currency
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
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
Sets the name of this commerce currency.- Parameters:
name
- the name of this commerce currency
-
setName
Sets the localized name of this commerce currency in the language.- Parameters:
name
- the localized name of this commerce currencylocale
- the locale of the language
-
setName
Sets the localized name of this commerce currency in the language, and sets the default locale.- Parameters:
name
- the localized name of this commerce currencylocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
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
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 currencydefaultLocale
- the default locale
-
getSymbol
Returns the symbol of this commerce currency.- Returns:
- the symbol of this commerce currency
-
setSymbol
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
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
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
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 languageuseDefault
- 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
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getFormatPattern
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized format pattern of this commerce currency
-
getFormatPatternCurrentLanguageId
-
getFormatPatternCurrentValue
-
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
Sets the format pattern of this commerce currency.- Parameters:
formatPattern
- the format pattern of this commerce currency
-
setFormatPattern
Sets the localized format pattern of this commerce currency in the language.- Parameters:
formatPattern
- the localized format pattern of this commerce currencylocale
- the locale of the language
-
setFormatPattern
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 currencylocale
- the locale of the languagedefaultLocale
- the default locale
-
setFormatPatternCurrentLanguageId
-
setFormatPatternMap
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
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 currencydefaultLocale
- 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
Returns the rounding mode of this commerce currency.- Returns:
- the rounding mode of this commerce currency
-
setRoundingMode
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()Returnstrue
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()Returnstrue
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
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 interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.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 interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
CommerceCurrency cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<CommerceCurrency>
-
toXmlString
-