com.liferay.commerce.model

Interface CommercePaymentMethodModel

All Superinterfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>, com.liferay.portal.kernel.model.ClassedModel, java.lang.Cloneable, java.lang.Comparable<CommercePaymentMethod>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, java.io.Serializable, com.liferay.portal.kernel.model.ShardedModel

All Known Subinterfaces:

CommercePaymentMethod

All Known Implementing Classes:

CommercePaymentMethodWrapper

@ProviderType
public interface CommercePaymentMethodModel
extends com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.ShardedModel

The base model interface for the CommercePaymentMethod service. Represents a row in the "CommercePaymentMethod" database table, with each column mapped to a property of this class.

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

See Also:

CommercePaymentMethod, com.liferay.commerce.model.impl.CommercePaymentMethodImpl, com.liferay.commerce.model.impl.CommercePaymentMethodModelImpl

Generated:

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(CommercePaymentMethod commercePaymentMethod)
boolean	getActive() Returns the active of this commerce payment method.
java.lang.String[]	getAvailableLanguageIds()
long	getCommercePaymentMethodId() Returns the commerce payment method ID of this commerce payment method.
long	getCompanyId() Returns the company ID of this commerce payment method.
java.util.Date	getCreateDate() Returns the create date of this commerce payment method.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this commerce payment method.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this commerce payment method in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this commerce payment 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 payment method in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this commerce payment 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 payment method.
java.lang.String	getEngineKey() Returns the engine key of this commerce payment method.
com.liferay.expando.kernel.model.ExpandoBridge	getExpandoBridge()
long	getGroupId() Returns the group ID of this commerce payment method.
long	getImageId() Returns the image ID of this commerce payment method.
java.util.Date	getModifiedDate() Returns the modified date of this commerce payment method.
java.lang.String	getName() Returns the name of this commerce payment method.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this commerce payment method in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this commerce payment 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 payment method in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this commerce payment 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 payment method.
long	getPrimaryKey() Returns the primary key of this commerce payment method.
java.io.Serializable	getPrimaryKeyObj()
double	getPriority() Returns the priority of this commerce payment method.
long	getUserId() Returns the user ID of this commerce payment method.
java.lang.String	getUserName() Returns the user name of this commerce payment method.
java.lang.String	getUserUuid() Returns the user uuid of this commerce payment method.
int	hashCode()
boolean	isActive() Returns true if this commerce payment method is active.
boolean	isCachedModel()
boolean	isEscapedModel()
boolean	isNew()
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setActive(boolean active) Sets whether this commerce payment method is active.
void	setCachedModel(boolean cachedModel)
void	setCommercePaymentMethodId(long commercePaymentMethodId) Sets the commerce payment method ID of this commerce payment method.
void	setCompanyId(long companyId) Sets the company ID of this commerce payment method.
void	setCreateDate(java.util.Date createDate) Sets the create date of this commerce payment method.
void	setDescription(java.lang.String description) Sets the description of this commerce payment method.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this commerce payment 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 payment 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 payment 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 payment 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 payment method.
void	setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	setGroupId(long groupId) Sets the group ID of this commerce payment method.
void	setImageId(long imageId) Sets the image ID of this commerce payment method.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this commerce payment method.
void	setName(java.lang.String name) Sets the name of this commerce payment method.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this commerce payment 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 payment 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 payment 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 payment method from the map of locales and localized names, and sets the default locale.
void	setNew(boolean n)
void	setPrimaryKey(long primaryKey) Sets the primary key of this commerce payment method.
void	setPrimaryKeyObj(java.io.Serializable primaryKeyObj)
void	setPriority(double priority) Sets the priority of this commerce payment method.
void	setUserId(long userId) Sets the user ID of this commerce payment method.
void	setUserName(java.lang.String userName) Sets the user name of this commerce payment method.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this commerce payment method.
com.liferay.portal.kernel.model.CacheModel<CommercePaymentMethod>	toCacheModel()
CommercePaymentMethod	toEscapedModel()
java.lang.String	toString()
CommercePaymentMethod	toUnescapedModel()
java.lang.String	toXmlString()

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this commerce payment method.

Returns:

the primary key of this commerce payment method

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this commerce payment method.

Parameters:

primaryKey - the primary key of this commerce payment method

getCommercePaymentMethodId

long getCommercePaymentMethodId()

Returns the commerce payment method ID of this commerce payment method.

Returns:

the commerce payment method ID of this commerce payment method

setCommercePaymentMethodId

void setCommercePaymentMethodId(long commercePaymentMethodId)

Sets the commerce payment method ID of this commerce payment method.

Parameters:

commercePaymentMethodId - the commerce payment method ID of this commerce payment method

getGroupId

long getGroupId()

Returns the group ID of this commerce payment method.

Specified by:

getGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Returns:

the group ID of this commerce payment method

setGroupId

void setGroupId(long groupId)

Sets the group ID of this commerce payment method.

Specified by:

setGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Parameters:

groupId - the group ID of this commerce payment method

getCompanyId

long getCompanyId()

Returns the company ID of this commerce payment method.

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Returns:

the company ID of this commerce payment method

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this commerce payment method.

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Parameters:

companyId - the company ID of this commerce payment method

getUserId

long getUserId()

Returns the user ID of this commerce payment method.

Specified by:

getUserId in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user ID of this commerce payment method

setUserId

void setUserId(long userId)

Sets the user ID of this commerce payment method.

Specified by:

setUserId in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userId - the user ID of this commerce payment method

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this commerce payment method.

Specified by:

getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user uuid of this commerce payment method

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this commerce payment method.

Specified by:

setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userUuid - the user uuid of this commerce payment method

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this commerce payment method.

Specified by:

getUserName in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user name of this commerce payment method

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this commerce payment method.

Specified by:

setUserName in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userName - the user name of this commerce payment method

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this commerce payment method.

Specified by:

getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the create date of this commerce payment method

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this commerce payment method.

Specified by:

setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

createDate - the create date of this commerce payment method

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this commerce payment method.

Specified by:

getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the modified date of this commerce payment method

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this commerce payment method.

Specified by:

setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

modifiedDate - the modified date of this commerce payment method

getName

java.lang.String getName()

Returns the name of this commerce payment method.

Returns:

the name of this commerce payment method

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale)

Returns the localized name of this commerce payment 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 payment method

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale,
                                     boolean useDefault)

Returns the localized name of this commerce payment method 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 payment method. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId)

Returns the localized name of this commerce payment 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 payment method

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId,
                                     boolean useDefault)

Returns the localized name of this commerce payment method 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 payment method

getNameCurrentLanguageId

@AutoEscape
java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this commerce payment method.

Returns:

the locales and localized names of this commerce payment method

setName

void setName(java.lang.String name)

Sets the name of this commerce payment method.

Parameters:

name - the name of this commerce payment method

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the localized name of this commerce payment method in the language.

Parameters:

name - the localized name of this commerce payment method

locale - the locale of the language

setName

void setName(java.lang.String name,
             java.util.Locale locale,
             java.util.Locale defaultLocale)

Sets the localized name of this commerce payment method in the language, and sets the default locale.

Parameters:

name - the localized name of this commerce payment method

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(java.lang.String languageId)

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)

Sets the localized names of this commerce payment method from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this commerce payment method

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                java.util.Locale defaultLocale)

Sets the localized names of this commerce payment method from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this commerce payment method

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this commerce payment method.

Returns:

the description of this commerce payment method

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of this commerce payment 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 payment method

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale,
                                            boolean useDefault)

Returns the localized description of this commerce payment method 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 description of this commerce payment method. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

Returns the localized description of this commerce payment 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 payment method

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
                                            boolean useDefault)

Returns the localized description of this commerce payment method 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 description of this commerce payment method

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this commerce payment method.

Returns:

the locales and localized descriptions of this commerce payment method

setDescription

void setDescription(java.lang.String description)

Sets the description of this commerce payment method.

Parameters:

description - the description of this commerce payment method

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this commerce payment method in the language.

Parameters:

description - the localized description of this commerce payment method

locale - the locale of the language

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized description of this commerce payment method in the language, and sets the default locale.

Parameters:

description - the localized description of this commerce payment method

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

Sets the localized descriptions of this commerce payment method from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this commerce payment method

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

Sets the localized descriptions of this commerce payment method from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this commerce payment method

defaultLocale - the default locale

getImageId

long getImageId()

Returns the image ID of this commerce payment method.

Returns:

the image ID of this commerce payment method

setImageId

void setImageId(long imageId)

Sets the image ID of this commerce payment method.

Parameters:

imageId - the image ID of this commerce payment method

getEngineKey

@AutoEscape
java.lang.String getEngineKey()

Returns the engine key of this commerce payment method.

Returns:

the engine key of this commerce payment method

setEngineKey

void setEngineKey(java.lang.String engineKey)

Sets the engine key of this commerce payment method.

Parameters:

engineKey - the engine key of this commerce payment method

getPriority

double getPriority()

Returns the priority of this commerce payment method.

Returns:

the priority of this commerce payment method

setPriority

void setPriority(double priority)

Sets the priority of this commerce payment method.

Parameters:

priority - the priority of this commerce payment method

getActive

boolean getActive()

Returns the active of this commerce payment method.

Returns:

the active of this commerce payment method

isActive

boolean isActive()

Returns true if this commerce payment method is active.

Returns:

true if this commerce payment method is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this commerce payment method is active.

Parameters:

active - the active of this commerce payment method

isNew

boolean isNew()

Specified by:

isNew in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

setNew

void setNew(boolean n)

Specified by:

setNew in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

isCachedModel

boolean isCachedModel()

Specified by:

isCachedModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

setCachedModel

void setCachedModel(boolean cachedModel)

Specified by:

setCachedModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

isEscapedModel

boolean isEscapedModel()

Specified by:

isEscapedModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Specified by:

getPrimaryKeyObj in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

Specified by:

getPrimaryKeyObj in interface com.liferay.portal.kernel.model.ClassedModel

setPrimaryKeyObj

void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Specified by:

setPrimaryKeyObj in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

Specified by:

setPrimaryKeyObj in interface com.liferay.portal.kernel.model.ClassedModel

getExpandoBridge

com.liferay.expando.kernel.model.ExpandoBridge getExpandoBridge()

Specified by:

getExpandoBridge in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

Specified by:

getExpandoBridge in interface com.liferay.portal.kernel.model.ClassedModel

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(com.liferay.portal.kernel.model.BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(com.liferay.expando.kernel.model.ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(com.liferay.portal.kernel.service.ServiceContext serviceContext)

Specified by:

setExpandoBridgeAttributes in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel

getDefaultLanguageId

java.lang.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(java.util.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

clone

java.lang.Object clone()

Specified by:

clone in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

compareTo

int compareTo(CommercePaymentMethod commercePaymentMethod)

Specified by:

compareTo in interface java.lang.Comparable<CommercePaymentMethod>

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

toCacheModel

com.liferay.portal.kernel.model.CacheModel<CommercePaymentMethod> toCacheModel()

Specified by:

toCacheModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

toEscapedModel

CommercePaymentMethod toEscapedModel()

Specified by:

toEscapedModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

toUnescapedModel

CommercePaymentMethod toUnescapedModel()

Specified by:

toUnescapedModel in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXmlString

java.lang.String toXmlString()

Specified by:

toXmlString in interface com.liferay.portal.kernel.model.BaseModel<CommercePaymentMethod>