Package com.liferay.commerce.model
Interface CommerceShippingMethodModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<CommerceShippingMethod>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<CommerceShippingMethod>
,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
- All Known Subinterfaces:
CommerceShippingMethod
- All Known Implementing Classes:
CommerceShippingMethodWrapper
@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
The base model interface for the CommerceShippingMethod service. Represents a row in the "CommerceShippingMethod" database table, with each column mapped to a property of this class.
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
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the active of this commerce shipping method.String[]
long
Returns the commerce shipping method ID of this commerce shipping method.long
Returns the company ID of this commerce shipping method.Returns the create date of this commerce shipping method.Returns the description of this commerce shipping method.getDescription
(String languageId) Returns the localized description of this commerce shipping method in the language.getDescription
(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.getDescription
(Locale locale) Returns the localized description of this commerce shipping method in the language.getDescription
(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.Returns a map of the locales and localized descriptions of this commerce shipping method.Returns the engine key of this commerce shipping method.long
Returns the group ID of this commerce shipping method.long
Returns the image ID of this commerce shipping method.Returns the modified date of this commerce shipping method.long
Returns the mvcc version of this commerce shipping method.getName()
Returns the name of this commerce shipping method.Returns the localized name of this commerce shipping method in the language.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.Returns the localized name of this commerce shipping method in the language.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.Returns a map of the locales and localized names of this commerce shipping method.long
Returns the primary key of this commerce shipping method.double
Returns the priority of this commerce shipping method.Returns the tracking url of this commerce shipping method.Returns the type settings of this commerce shipping method.long
Returns the user ID of this commerce shipping method.Returns the user name of this commerce shipping method.Returns the user uuid of this commerce shipping method.boolean
isActive()
Returnstrue
if this commerce shipping method is active.void
void
prepareLocalizedFieldsForImport
(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
(Date createDate) Sets the create date of this commerce shipping method.void
setDescription
(String description) Sets the description of this commerce shipping method.void
setDescription
(String description, Locale locale) Sets the localized description of this commerce shipping method in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this commerce shipping method in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, 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
(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
(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
Sets the name of this commerce shipping method.void
Sets the localized name of this commerce shipping method in the language.void
Sets the localized name of this commerce shipping method 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 shipping method from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, 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
(String trackingURL) Sets the tracking url of this commerce shipping method.void
setTypeSettings
(String typeSettings) Sets the type settings of this commerce shipping method.void
setUserId
(long userId) Sets the user ID of this commerce shipping method.void
setUserName
(String userName) Sets the user name of this commerce shipping method.void
setUserUuid
(String userUuid) Sets the user uuid of this commerce shipping method.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
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this commerce shipping method.- Returns:
- the primary key of this commerce shipping method
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this commerce shipping method.- Parameters:
primaryKey
- the primary key of this commerce shipping method
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this commerce shipping method.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this commerce shipping method
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this commerce shipping method.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this commerce shipping method
-
getCommerceShippingMethodId
long getCommerceShippingMethodId()Returns the commerce shipping method ID of this commerce shipping method.- Returns:
- the commerce shipping method ID of this commerce shipping method
-
setCommerceShippingMethodId
void setCommerceShippingMethodId(long commerceShippingMethodId) Sets the commerce shipping method ID of this commerce shipping method.- Parameters:
commerceShippingMethodId
- the commerce shipping method ID of this commerce shipping method
-
getGroupId
long getGroupId()Returns the group ID of this commerce shipping method.- Specified by:
getGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Returns:
- the group ID of this commerce shipping method
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this commerce shipping method.- Specified by:
setGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Parameters:
groupId
- the group ID of this commerce shipping method
-
getCompanyId
long getCompanyId()Returns the company ID of this commerce shipping method.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Returns:
- the company ID of this commerce shipping method
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this commerce shipping method.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Parameters:
companyId
- the company ID of this commerce shipping method
-
getUserId
long getUserId()Returns the user ID of this commerce shipping method.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this commerce shipping method
-
setUserId
void setUserId(long userId) Sets the user ID of this commerce shipping method.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this commerce shipping method
-
getUserUuid
String getUserUuid()Returns the user uuid of this commerce shipping method.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this commerce shipping method
-
setUserUuid
Sets the user uuid of this commerce shipping method.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this commerce shipping method
-
getUserName
Returns the user name of this commerce shipping method.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this commerce shipping method
-
setUserName
Sets the user name of this commerce shipping method.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this commerce shipping method
-
getCreateDate
Date getCreateDate()Returns the create date of this commerce shipping method.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the create date of this commerce shipping method
-
setCreateDate
Sets the create date of this commerce shipping method.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
createDate
- the create date of this commerce shipping method
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this commerce shipping method.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the modified date of this commerce shipping method
-
setModifiedDate
Sets the modified date of this commerce shipping method.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
modifiedDate
- the modified date of this commerce shipping method
-
getName
String getName()Returns the name of this commerce shipping method.- Returns:
- the name of this commerce shipping method
-
getName
Returns the localized name of this commerce shipping method 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 shipping method
-
getName
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.- 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 shipping method. 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 shipping method 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 shipping method
-
getName
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.- 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 shipping method
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this commerce shipping method.- Returns:
- the locales and localized names of this commerce shipping method
-
setName
Sets the name of this commerce shipping method.- Parameters:
name
- the name of this commerce shipping method
-
setName
Sets the localized name of this commerce shipping method in the language.- Parameters:
name
- the localized name of this commerce shipping methodlocale
- the locale of the language
-
setName
Sets the localized name of this commerce shipping method in the language, and sets the default locale.- Parameters:
name
- the localized name of this commerce shipping methodlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this commerce shipping method from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this commerce shipping method
-
setNameMap
Sets the localized names of this commerce shipping method from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this commerce shipping methoddefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this commerce shipping method.- Returns:
- the description of this commerce shipping method
-
getDescription
Returns the localized description of this commerce shipping method 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 commerce shipping method
-
getDescription
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.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this commerce shipping method. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this commerce shipping method 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 commerce shipping method
-
getDescription
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.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this commerce shipping method
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this commerce shipping method.- Returns:
- the locales and localized descriptions of this commerce shipping method
-
setDescription
Sets the description of this commerce shipping method.- Parameters:
description
- the description of this commerce shipping method
-
setDescription
Sets the localized description of this commerce shipping method in the language.- Parameters:
description
- the localized description of this commerce shipping methodlocale
- the locale of the language
-
setDescription
Sets the localized description of this commerce shipping method in the language, and sets the default locale.- Parameters:
description
- the localized description of this commerce shipping methodlocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this commerce shipping method
-
setDescriptionMap
Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this commerce shipping methoddefaultLocale
- the default locale
-
getActive
boolean getActive()Returns the active of this commerce shipping method.- Returns:
- the active of this commerce shipping method
-
isActive
boolean isActive()Returnstrue
if this commerce shipping method is active.- Returns:
true
if this commerce shipping method is active;false
otherwise
-
setActive
void setActive(boolean active) Sets whether this commerce shipping method is active.- Parameters:
active
- the active of this commerce shipping method
-
getEngineKey
Returns the engine key of this commerce shipping method.- Returns:
- the engine key of this commerce shipping method
-
setEngineKey
Sets the engine key of this commerce shipping method.- Parameters:
engineKey
- the engine key of this commerce shipping method
-
getImageId
long getImageId()Returns the image ID of this commerce shipping method.- Returns:
- the image ID of this commerce shipping method
-
setImageId
void setImageId(long imageId) Sets the image ID of this commerce shipping method.- Parameters:
imageId
- the image ID of this commerce shipping method
-
getPriority
double getPriority()Returns the priority of this commerce shipping method.- Returns:
- the priority of this commerce shipping method
-
setPriority
void setPriority(double priority) Sets the priority of this commerce shipping method.- Parameters:
priority
- the priority of this commerce shipping method
-
getTrackingURL
Returns the tracking url of this commerce shipping method.- Returns:
- the tracking url of this commerce shipping method
-
setTrackingURL
Sets the tracking url of this commerce shipping method.- Parameters:
trackingURL
- the tracking url of this commerce shipping method
-
getTypeSettings
Returns the type settings of this commerce shipping method.- Returns:
- the type settings of this commerce shipping method
-
setTypeSettings
Sets the type settings of this commerce shipping method.- Parameters:
typeSettings
- the type settings of this commerce shipping method
-
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
CommerceShippingMethod cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<CommerceShippingMethod>
-
toXmlString
-