com.liferay.commerce.product.model

Interface CPSpecificationOptionModel

All Superinterfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<CPSpecificationOption>, com.liferay.portal.kernel.model.ClassedModel, java.lang.Cloneable, java.lang.Comparable<CPSpecificationOption>, 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:

CPSpecificationOption

All Known Implementing Classes:

CPSpecificationOptionWrapper

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

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

See Also:

CPSpecificationOption

Generated:

Method Summary

Modifier and Type	Method and Description
CPSpecificationOption	cloneWithOriginalValues()
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this cp specification option.
long	getCPOptionCategoryId() Returns the cp option category ID of this cp specification option.
long	getCPSpecificationOptionId() Returns the cp specification option ID of this cp specification option.
java.util.Date	getCreateDate() Returns the create date of this cp specification option.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this cp specification option.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this cp specification option in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this cp specification 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 specification option in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this cp specification 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 specification option.
boolean	getFacetable() Returns the facetable of this cp specification option.
java.lang.String	getKey() Returns the key of this cp specification option.
java.util.Date	getLastPublishDate() Returns the last publish date of this cp specification option.
java.util.Date	getModifiedDate() Returns the modified date of this cp specification option.
long	getMvccVersion() Returns the mvcc version of this cp specification option.
long	getPrimaryKey() Returns the primary key of this cp specification option.
java.lang.String	getTitle() Returns the title of this cp specification option.
java.lang.String	getTitle(java.util.Locale locale) Returns the localized title of this cp specification option in the language.
java.lang.String	getTitle(java.util.Locale locale, boolean useDefault) Returns the localized title of this cp specification option in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getTitle(java.lang.String languageId) Returns the localized title of this cp specification option in the language.
java.lang.String	getTitle(java.lang.String languageId, boolean useDefault) Returns the localized title of this cp specification option in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getTitleCurrentLanguageId()
java.lang.String	getTitleCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getTitleMap() Returns a map of the locales and localized titles of this cp specification option.
long	getUserId() Returns the user ID of this cp specification option.
java.lang.String	getUserName() Returns the user name of this cp specification option.
java.lang.String	getUserUuid() Returns the user uuid of this cp specification option.
java.lang.String	getUuid() Returns the uuid of this cp specification option.
boolean	isFacetable() Returns true if this cp specification option is facetable.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCompanyId(long companyId) Sets the company ID of this cp specification option.
void	setCPOptionCategoryId(long CPOptionCategoryId) Sets the cp option category ID of this cp specification option.
void	setCPSpecificationOptionId(long CPSpecificationOptionId) Sets the cp specification option ID of this cp specification option.
void	setCreateDate(java.util.Date createDate) Sets the create date of this cp specification option.
void	setDescription(java.lang.String description) Sets the description of this cp specification option.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this cp specification 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 specification 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 specification 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 specification option from the map of locales and localized descriptions, and sets the default locale.
void	setFacetable(boolean facetable) Sets whether this cp specification option is facetable.
void	setKey(java.lang.String key) Sets the key of this cp specification option.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this cp specification option.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this cp specification option.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this cp specification option.
void	setPrimaryKey(long primaryKey) Sets the primary key of this cp specification option.
void	setTitle(java.lang.String title) Sets the title of this cp specification option.
void	setTitle(java.lang.String title, java.util.Locale locale) Sets the localized title of this cp specification option in the language.
void	setTitle(java.lang.String title, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized title of this cp specification option in the language, and sets the default locale.
void	setTitleCurrentLanguageId(java.lang.String languageId)
void	setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap) Sets the localized titles of this cp specification option from the map of locales and localized titles.
void	setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Locale defaultLocale) Sets the localized titles of this cp specification option from the map of locales and localized titles, and sets the default locale.
void	setUserId(long userId) Sets the user ID of this cp specification option.
void	setUserName(java.lang.String userName) Sets the user name of this cp specification option.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this cp specification option.
void	setUuid(java.lang.String uuid) Sets the uuid of this cp specification 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 specification option.

Returns:

the primary key of this cp specification option

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this cp specification option.

Parameters:

primaryKey - the primary key of this cp specification option

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this cp specification option.

Specified by:

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

Returns:

the mvcc version of this cp specification option

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this cp specification option.

Specified by:

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

Parameters:

mvccVersion - the mvcc version of this cp specification option

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this cp specification option.

Specified by:

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

Returns:

the uuid of this cp specification option

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this cp specification option.

Specified by:

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

Parameters:

uuid - the uuid of this cp specification option

getCPSpecificationOptionId

long getCPSpecificationOptionId()

Returns the cp specification option ID of this cp specification option.

Returns:

the cp specification option ID of this cp specification option

setCPSpecificationOptionId

void setCPSpecificationOptionId(long CPSpecificationOptionId)

Sets the cp specification option ID of this cp specification option.

Parameters:

CPSpecificationOptionId - the cp specification option ID of this cp specification option

getCompanyId

long getCompanyId()

Returns the company ID of this cp specification 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 specification option

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this cp specification 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 specification option

getUserId

long getUserId()

Returns the user ID of this cp specification option.

Specified by:

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

Returns:

the user ID of this cp specification option

setUserId

void setUserId(long userId)

Sets the user ID of this cp specification option.

Specified by:

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

Parameters:

userId - the user ID of this cp specification option

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this cp specification option.

Specified by:

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

Returns:

the user uuid of this cp specification option

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this cp specification option.

Specified by:

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

Parameters:

userUuid - the user uuid of this cp specification option

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this cp specification option.

Specified by:

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

Returns:

the user name of this cp specification option

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this cp specification option.

Specified by:

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

Parameters:

userName - the user name of this cp specification option

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this cp specification 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 specification option

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this cp specification 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 specification option

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this cp specification 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 specification option

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this cp specification 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 specification option

getCPOptionCategoryId

long getCPOptionCategoryId()

Returns the cp option category ID of this cp specification option.

Returns:

the cp option category ID of this cp specification option

setCPOptionCategoryId

void setCPOptionCategoryId(long CPOptionCategoryId)

Sets the cp option category ID of this cp specification option.

Parameters:

CPOptionCategoryId - the cp option category ID of this cp specification option

getTitle

java.lang.String getTitle()

Returns the title of this cp specification option.

Returns:

the title of this cp specification option

getTitle

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

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

getTitle

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

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

getTitle

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

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

getTitle

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

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

getTitleCurrentLanguageId

@AutoEscape
java.lang.String getTitleCurrentLanguageId()

getTitleCurrentValue

@AutoEscape
java.lang.String getTitleCurrentValue()

getTitleMap

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

Returns a map of the locales and localized titles of this cp specification option.

Returns:

the locales and localized titles of this cp specification option

setTitle

void setTitle(java.lang.String title)

Sets the title of this cp specification option.

Parameters:

title - the title of this cp specification option

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale)

Sets the localized title of this cp specification option in the language.

Parameters:

title - the localized title of this cp specification option

locale - the locale of the language

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale,
              java.util.Locale defaultLocale)

Sets the localized title of this cp specification option in the language, and sets the default locale.

Parameters:

title - the localized title of this cp specification option

locale - the locale of the language

defaultLocale - the default locale

setTitleCurrentLanguageId

void setTitleCurrentLanguageId(java.lang.String languageId)

setTitleMap

void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap)

Sets the localized titles of this cp specification option from the map of locales and localized titles.

Parameters:

titleMap - the locales and localized titles of this cp specification option

setTitleMap

void setTitleMap(java.util.Map<java.util.Locale,java.lang.String> titleMap,
                 java.util.Locale defaultLocale)

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

Parameters:

titleMap - the locales and localized titles of this cp specification option

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this cp specification option.

Returns:

the description of this cp specification option

getDescription

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

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

getDescription

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

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

getDescription

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

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

Returns:

the locales and localized descriptions of this cp specification option

setDescription

void setDescription(java.lang.String description)

Sets the description of this cp specification option.

Parameters:

description - the description of this cp specification option

setDescription

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

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

Parameters:

description - the localized description of this cp specification 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 specification option in the language, and sets the default locale.

Parameters:

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

Parameters:

descriptionMap - the locales and localized descriptions of this cp specification 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 specification option from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this cp specification option

defaultLocale - the default locale

getFacetable

boolean getFacetable()

Returns the facetable of this cp specification option.

Returns:

the facetable of this cp specification option

isFacetable

boolean isFacetable()

Returns true if this cp specification option is facetable.

Returns:

true if this cp specification option is facetable; false otherwise

setFacetable

void setFacetable(boolean facetable)

Sets whether this cp specification option is facetable.

Parameters:

facetable - the facetable of this cp specification option

getKey

@AutoEscape
java.lang.String getKey()

Returns the key of this cp specification option.

Returns:

the key of this cp specification option

setKey

void setKey(java.lang.String key)

Sets the key of this cp specification option.

Parameters:

key - the key of this cp specification option

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this cp specification option.

Returns:

the last publish date of this cp specification option

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this cp specification option.

Parameters:

lastPublishDate - the last publish date of this cp specification 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

CPSpecificationOption cloneWithOriginalValues()

Specified by:

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