@ProviderType public interface CommerceShippingMethodModel extends com.liferay.portal.kernel.model.BaseModel<CommerceShippingMethod>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel
This interface and its corresponding implementation com.liferay.commerce.model.impl.CommerceShippingMethodModelImpl 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.model.impl.CommerceShippingMethodImpl.
CommerceShippingMethod| Modifier and Type | Method and Description |
|---|---|
CommerceShippingMethod |
cloneWithOriginalValues() |
boolean |
getActive()
Returns the active of this commerce shipping method.
|
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCommerceShippingMethodId()
Returns the commerce shipping method ID of this commerce shipping method.
|
long |
getCompanyId()
Returns the company ID of this commerce shipping method.
|
java.util.Date |
getCreateDate()
Returns the create date of this commerce shipping method.
|
java.lang.String |
getDefaultLanguageId() |
java.lang.String |
getDescription()
Returns the description of this commerce shipping method.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this commerce shipping method in the language.
|
java.lang.String |
getDescription(java.util.Locale locale,
boolean useDefault)
Returns the localized description of this commerce shipping method in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getDescription(java.lang.String languageId)
Returns the localized description of this commerce shipping method in the language.
|
java.lang.String |
getDescription(java.lang.String languageId,
boolean useDefault)
Returns the localized description of this commerce shipping method in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getDescriptionCurrentLanguageId() |
java.lang.String |
getDescriptionCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this commerce shipping method.
|
java.lang.String |
getEngineKey()
Returns the engine key of this commerce shipping method.
|
long |
getGroupId()
Returns the group ID of this commerce shipping method.
|
long |
getImageId()
Returns the image ID of this commerce shipping method.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this commerce shipping method.
|
long |
getMvccVersion()
Returns the mvcc version of this commerce shipping method.
|
java.lang.String |
getName()
Returns the name of this commerce shipping method.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this commerce shipping method in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this commerce shipping method in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getName(java.lang.String languageId)
Returns the localized name of this commerce shipping method in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this commerce shipping method in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getNameCurrentLanguageId() |
java.lang.String |
getNameCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getNameMap()
Returns a map of the locales and localized names of this commerce shipping method.
|
long |
getPrimaryKey()
Returns the primary key of this commerce shipping method.
|
double |
getPriority()
Returns the priority of this commerce shipping method.
|
java.lang.String |
getTrackingURL()
Returns the tracking url of this commerce shipping method.
|
long |
getUserId()
Returns the user ID of this commerce shipping method.
|
java.lang.String |
getUserName()
Returns the user name of this commerce shipping method.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this commerce shipping method.
|
boolean |
isActive()
Returns
true if this commerce shipping method is active. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setActive(boolean active)
Sets whether this commerce shipping method is active.
|
void |
setCommerceShippingMethodId(long commerceShippingMethodId)
Sets the commerce shipping method ID of this commerce shipping method.
|
void |
setCompanyId(long companyId)
Sets the company ID of this commerce shipping method.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this commerce shipping method.
|
void |
setDescription(java.lang.String description)
Sets the description of this commerce shipping method.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the localized description of this commerce shipping method in the language.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized description of this commerce shipping method in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(java.lang.String languageId) |
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions.
|
void |
setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions, and sets the default locale.
|
void |
setEngineKey(java.lang.String engineKey)
Sets the engine key of this commerce shipping method.
|
void |
setGroupId(long groupId)
Sets the group ID of this commerce shipping method.
|
void |
setImageId(long imageId)
Sets the image ID of this commerce shipping method.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this commerce shipping method.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this commerce shipping method.
|
void |
setName(java.lang.String name)
Sets the name of this commerce shipping method.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this commerce shipping method in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this commerce shipping method in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(java.lang.String languageId) |
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
Sets the localized names of this commerce shipping method from the map of locales and localized names.
|
void |
setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
Sets the localized names of this commerce shipping method from the map of locales and localized names, and sets the default locale.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this commerce shipping method.
|
void |
setPriority(double priority)
Sets the priority of this commerce shipping method.
|
void |
setTrackingURL(java.lang.String trackingURL)
Sets the tracking url of this commerce shipping method.
|
void |
setUserId(long userId)
Sets the user ID of this commerce shipping method.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this commerce shipping method.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this commerce shipping method.
|
default java.lang.String |
toXmlString() |
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModellong getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey - the primary key of this commerce shipping methodlong getMvccVersion()
getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelmvccVersion - the mvcc version of this commerce shipping methodlong getCommerceShippingMethodId()
void setCommerceShippingMethodId(long commerceShippingMethodId)
commerceShippingMethodId - the commerce shipping method ID of this commerce shipping methodlong getGroupId()
getGroupId in interface com.liferay.portal.kernel.model.GroupedModelvoid setGroupId(long groupId)
setGroupId in interface com.liferay.portal.kernel.model.GroupedModelgroupId - the group ID of this commerce shipping methodlong getCompanyId()
getCompanyId in interface com.liferay.portal.kernel.model.AuditedModelgetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelvoid setCompanyId(long companyId)
setCompanyId in interface com.liferay.portal.kernel.model.AuditedModelsetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelcompanyId - the company ID of this commerce shipping methodlong getUserId()
getUserId in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserId(long userId)
setUserId in interface com.liferay.portal.kernel.model.AuditedModeluserId - the user ID of this commerce shipping methodjava.lang.String getUserUuid()
getUserUuid in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserUuid(java.lang.String userUuid)
setUserUuid in interface com.liferay.portal.kernel.model.AuditedModeluserUuid - the user uuid of this commerce shipping method@AutoEscape java.lang.String getUserName()
getUserName in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserName(java.lang.String userName)
setUserName in interface com.liferay.portal.kernel.model.AuditedModeluserName - the user name of this commerce shipping methodjava.util.Date getCreateDate()
getCreateDate in interface com.liferay.portal.kernel.model.AuditedModelvoid setCreateDate(java.util.Date createDate)
setCreateDate in interface com.liferay.portal.kernel.model.AuditedModelcreateDate - the create date of this commerce shipping methodjava.util.Date getModifiedDate()
getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelvoid setModifiedDate(java.util.Date modifiedDate)
setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelmodifiedDate - the modified date of this commerce shipping methodjava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getName(java.util.Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getName(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getName(java.lang.String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name - the name of this commerce shipping methodvoid setName(java.lang.String name,
java.util.Locale locale)
name - the localized name of this commerce shipping methodlocale - the locale of the languagevoid setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
name - the localized name of this commerce shipping methodlocale - the locale of the languagedefaultLocale - the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap - the locales and localized names of this commerce shipping methodvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
nameMap - the locales and localized names of this commerce shipping methoddefaultLocale - the default localejava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getDescription(java.util.Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getDescription(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description - the description of this commerce shipping methodvoid setDescription(java.lang.String description,
java.util.Locale locale)
description - the localized description of this commerce shipping methodlocale - the locale of the languagevoid setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
description - the localized description of this commerce shipping methodlocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap - the locales and localized descriptions of this commerce shipping methodvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this commerce shipping methoddefaultLocale - the default localeboolean getActive()
boolean isActive()
true if this commerce shipping method is active.true if this commerce shipping method is active; false otherwisevoid setActive(boolean active)
active - the active of this commerce shipping method@AutoEscape java.lang.String getEngineKey()
void setEngineKey(java.lang.String engineKey)
engineKey - the engine key of this commerce shipping methodlong getImageId()
void setImageId(long imageId)
imageId - the image ID of this commerce shipping methoddouble getPriority()
void setPriority(double priority)
priority - the priority of this commerce shipping method@AutoEscape java.lang.String getTrackingURL()
void setTrackingURL(java.lang.String trackingURL)
trackingURL - the tracking url of this commerce shipping methodjava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModeljava.lang.String getDefaultLanguageId()
getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModelvoid prepareLocalizedFieldsForImport()
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionvoid prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionCommerceShippingMethod cloneWithOriginalValues()
cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<CommerceShippingMethod>default java.lang.String toXmlString()