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 TypeMethodDescriptionbooleanReturns the active of this commerce shipping method.String[]longReturns the commerce shipping method ID of this commerce shipping method.longReturns 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.longReturns the group ID of this commerce shipping method.longReturns the image ID of this commerce shipping method.Returns the modified date of this commerce shipping method.longReturns 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.longReturns the primary key of this commerce shipping method.doubleReturns 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.longReturns 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.booleanisActive()Returnstrueif this commerce shipping method is active.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetActive(boolean active) Sets whether this commerce shipping method is active.voidsetCommerceShippingMethodId(long commerceShippingMethodId) Sets the commerce shipping method ID of this commerce shipping method.voidsetCompanyId(long companyId) Sets the company ID of this commerce shipping method.voidsetCreateDate(Date createDate) Sets the create date of this commerce shipping method.voidsetDescription(String description) Sets the description of this commerce shipping method.voidsetDescription(String description, Locale locale) Sets the localized description of this commerce shipping method in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this commerce shipping method in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this commerce shipping method from the map of locales and localized descriptions.voidsetDescriptionMap(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.voidsetEngineKey(String engineKey) Sets the engine key of this commerce shipping method.voidsetGroupId(long groupId) Sets the group ID of this commerce shipping method.voidsetImageId(long imageId) Sets the image ID of this commerce shipping method.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this commerce shipping method.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this commerce shipping method.voidSets the name of this commerce shipping method.voidSets the localized name of this commerce shipping method in the language.voidSets the localized name of this commerce shipping method in the language, and sets the default locale.voidsetNameCurrentLanguageId(String languageId) voidsetNameMap(Map<Locale, String> nameMap) Sets the localized names of this commerce shipping method from the map of locales and localized names.voidsetNameMap(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.voidsetPrimaryKey(long primaryKey) Sets the primary key of this commerce shipping method.voidsetPriority(double priority) Sets the priority of this commerce shipping method.voidsetTrackingURL(String trackingURL) Sets the tracking url of this commerce shipping method.voidsetTypeSettings(String typeSettings) Sets the type settings of this commerce shipping method.voidsetUserId(long userId) Sets the user ID of this commerce shipping method.voidsetUserName(String userName) Sets the user name of this commerce shipping method.voidsetUserUuid(String userUuid) Sets the user uuid of this commerce shipping method.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods 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:
getMvccVersionin 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:
setMvccVersionin 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:
getGroupIdin 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:
setGroupIdin 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:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin 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:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin 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:
getUserIdin 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:
setUserIdin 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:
getUserUuidin 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:
setUserUuidin 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:
getUserNamein 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:
setUserNamein 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:
getCreateDatein 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:
setCreateDatein 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:
getModifiedDatein 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:
setModifiedDatein 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
useDefaultisfalseand 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
useDefaultisfalseand 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()Returnstrueif this commerce shipping method is active.- Returns:
trueif this commerce shipping method is active;falseotherwise
-
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:
getAvailableLanguageIdsin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImportin 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:
prepareLocalizedFieldsForImportin interfacecom.liferay.portal.kernel.model.LocalizedModel- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
CommerceShippingMethod cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<CommerceShippingMethod>
-
toXmlString
-