com.liferay.commerce.product.model

Interface CPOptionModel

All Superinterfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<CPOption>, com.liferay.portal.kernel.model.ClassedModel, java.lang.Cloneable, java.lang.Comparable<CPOption>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, java.io.Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel, com.liferay.portal.kernel.model.StagedModel

All Known Subinterfaces:

CPOption

All Known Implementing Classes:

CPOptionWrapper

@ProviderType
public interface CPOptionModel
extends com.liferay.portal.kernel.model.BaseModel<CPOption>, 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 CPOption service. Represents a row in the "CPOption" database table, with each column mapped to a property of this class.

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

See Also:

CPOption

Generated:

Method Summary

Modifier and Type	Method and Description
CPOption	cloneWithOriginalValues()
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this cp option.
long	getCPOptionId() Returns the cp option ID of this cp option.
java.util.Date	getCreateDate() Returns the create date of this cp option.
java.lang.String	getDDMFormFieldTypeName() Returns the ddm form field type name of this cp option.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this cp option.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this cp option in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this cp option 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 cp option in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this cp option 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 cp option.
java.lang.String	getExternalReferenceCode() Returns the external reference code of this cp option.
boolean	getFacetable() Returns the facetable of this cp option.
java.lang.String	getKey() Returns the key of this cp option.
java.util.Date	getLastPublishDate() Returns the last publish date of this cp option.
java.util.Date	getModifiedDate() Returns the modified date of this cp option.
long	getMvccVersion() Returns the mvcc version of this cp option.
java.lang.String	getName() Returns the name of this cp option.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this cp option in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this cp option 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 cp option in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this cp option 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 cp option.
long	getPrimaryKey() Returns the primary key of this cp option.
boolean	getRequired() Returns the required of this cp option.
boolean	getSkuContributor() Returns the sku contributor of this cp option.
long	getUserId() Returns the user ID of this cp option.
java.lang.String	getUserName() Returns the user name of this cp option.
java.lang.String	getUserUuid() Returns the user uuid of this cp option.
java.lang.String	getUuid() Returns the uuid of this cp option.
boolean	isFacetable() Returns true if this cp option is facetable.
boolean	isRequired() Returns true if this cp option is required.
boolean	isSkuContributor() Returns true if this cp option is sku contributor.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCompanyId(long companyId) Sets the company ID of this cp option.
void	setCPOptionId(long CPOptionId) Sets the cp option ID of this cp option.
void	setCreateDate(java.util.Date createDate) Sets the create date of this cp option.
void	setDDMFormFieldTypeName(java.lang.String DDMFormFieldTypeName) Sets the ddm form field type name of this cp option.
void	setDescription(java.lang.String description) Sets the description of this cp option.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this cp option in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this cp option 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 cp option 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 cp option from the map of locales and localized descriptions, and sets the default locale.
void	setExternalReferenceCode(java.lang.String externalReferenceCode) Sets the external reference code of this cp option.
void	setFacetable(boolean facetable) Sets whether this cp option is facetable.
void	setKey(java.lang.String key) Sets the key of this cp option.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this cp option.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this cp option.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this cp option.
void	setName(java.lang.String name) Sets the name of this cp option.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this cp option in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this cp option 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 cp option 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 cp option from the map of locales and localized names, and sets the default locale.
void	setPrimaryKey(long primaryKey) Sets the primary key of this cp option.
void	setRequired(boolean required) Sets whether this cp option is required.
void	setSkuContributor(boolean skuContributor) Sets whether this cp option is sku contributor.
void	setUserId(long userId) Sets the user ID of this cp option.
void	setUserName(java.lang.String userName) Sets the user name of this cp option.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this cp option.
void	setUuid(java.lang.String uuid) Sets the uuid of this cp option.

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, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

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

clone, getStagedModelType

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

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this cp option.

Returns:

the primary key of this cp option

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this cp option.

Parameters:

primaryKey - the primary key of this cp option

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this cp option.

Specified by:

getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel

Returns:

the mvcc version of this cp option

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this cp option.

Specified by:

setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel

Parameters:

mvccVersion - the mvcc version of this cp option

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this cp option.

Specified by:

getUuid in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the uuid of this cp option

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this cp option.

Specified by:

setUuid in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

uuid - the uuid of this cp option

getExternalReferenceCode

@AutoEscape
java.lang.String getExternalReferenceCode()

Returns the external reference code of this cp option.

Returns:

the external reference code of this cp option

setExternalReferenceCode

void setExternalReferenceCode(java.lang.String externalReferenceCode)

Sets the external reference code of this cp option.

Parameters:

externalReferenceCode - the external reference code of this cp option

getCPOptionId

long getCPOptionId()

Returns the cp option ID of this cp option.

Returns:

the cp option ID of this cp option

setCPOptionId

void setCPOptionId(long CPOptionId)

Sets the cp option ID of this cp option.

Parameters:

CPOptionId - the cp option ID of this cp option

getCompanyId

long getCompanyId()

Returns the company ID of this cp option.

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

the company ID of this cp option

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this cp option.

Specified by:

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

Specified by:

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

Specified by:

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

Parameters:

companyId - the company ID of this cp option

getUserId

long getUserId()

Returns the user ID of this cp option.

Specified by:

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

Returns:

the user ID of this cp option

setUserId

void setUserId(long userId)

Sets the user ID of this cp option.

Specified by:

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

Parameters:

userId - the user ID of this cp option

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this cp option.

Specified by:

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

Returns:

the user uuid of this cp option

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this cp option.

Specified by:

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

Parameters:

userUuid - the user uuid of this cp option

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this cp option.

Specified by:

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

Returns:

the user name of this cp option

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this cp option.

Specified by:

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

Parameters:

userName - the user name of this cp option

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this cp option.

Specified by:

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

Specified by:

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

Returns:

the create date of this cp option

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this cp option.

Specified by:

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

Specified by:

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

Parameters:

createDate - the create date of this cp option

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this cp option.

Specified by:

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

Specified by:

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

Returns:

the modified date of this cp option

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this cp option.

Specified by:

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

Specified by:

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

Parameters:

modifiedDate - the modified date of this cp option

getName

java.lang.String getName()

Returns the name of this cp option.

Returns:

the name of this cp option

getName

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

Returns the localized name of this cp option 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 cp option

getName

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

Returns the localized name of this cp option 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 cp option. 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 cp option 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 cp option

getName

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

Returns the localized name of this cp option 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 cp option

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 cp option.

Returns:

the locales and localized names of this cp option

setName

void setName(java.lang.String name)

Sets the name of this cp option.

Parameters:

name - the name of this cp option

setName

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

Sets the localized name of this cp option in the language.

Parameters:

name - the localized name of this cp option

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 cp option in the language, and sets the default locale.

Parameters:

name - the localized name of this cp option

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 cp option from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this cp option

setNameMap

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

Sets the localized names of this cp option from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this cp option

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this cp option.

Returns:

the description of this cp option

getDescription

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

Returns the localized description of this cp option 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 cp option

getDescription

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

Returns the localized description of this cp option 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 cp option. 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 cp option 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 cp option

getDescription

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

Returns the localized description of this cp option 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 cp option

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 cp option.

Returns:

the locales and localized descriptions of this cp option

setDescription

void setDescription(java.lang.String description)

Sets the description of this cp option.

Parameters:

description - the description of this cp option

setDescription

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

Sets the localized description of this cp option in the language.

Parameters:

description - the localized description of this cp option

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 cp option in the language, and sets the default locale.

Parameters:

description - the localized description of this cp option

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 cp option from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this cp option

setDescriptionMap

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

Sets the localized descriptions of this cp option from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this cp option

defaultLocale - the default locale

getDDMFormFieldTypeName

@AutoEscape
java.lang.String getDDMFormFieldTypeName()

Returns the ddm form field type name of this cp option.

Returns:

the ddm form field type name of this cp option

setDDMFormFieldTypeName

void setDDMFormFieldTypeName(java.lang.String DDMFormFieldTypeName)

Sets the ddm form field type name of this cp option.

Parameters:

DDMFormFieldTypeName - the ddm form field type name of this cp option

getFacetable

boolean getFacetable()

Returns the facetable of this cp option.

Returns:

the facetable of this cp option

isFacetable

boolean isFacetable()

Returns true if this cp option is facetable.

Returns:

true if this cp option is facetable; false otherwise

setFacetable

void setFacetable(boolean facetable)

Sets whether this cp option is facetable.

Parameters:

facetable - the facetable of this cp option

getRequired

boolean getRequired()

Returns the required of this cp option.

Returns:

the required of this cp option

isRequired

boolean isRequired()

Returns true if this cp option is required.

Returns:

true if this cp option is required; false otherwise

setRequired

void setRequired(boolean required)

Sets whether this cp option is required.

Parameters:

required - the required of this cp option

getSkuContributor

boolean getSkuContributor()

Returns the sku contributor of this cp option.

Returns:

the sku contributor of this cp option

isSkuContributor

boolean isSkuContributor()

Returns true if this cp option is sku contributor.

Returns:

true if this cp option is sku contributor; false otherwise

setSkuContributor

void setSkuContributor(boolean skuContributor)

Sets whether this cp option is sku contributor.

Parameters:

skuContributor - the sku contributor of this cp option

getKey

@AutoEscape
java.lang.String getKey()

Returns the key of this cp option.

Returns:

the key of this cp option

setKey

void setKey(java.lang.String key)

Sets the key of this cp option.

Parameters:

key - the key of this cp option

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this cp option.

Returns:

the last publish date of this cp option

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this cp option.

Parameters:

lastPublishDate - the last publish date of this cp option

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

cloneWithOriginalValues

CPOption cloneWithOriginalValues()

Specified by:

cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<CPOption>