@ProviderType public interface CPOptionModel extends com.liferay.portal.kernel.model.BaseModel<CPOption>, com.liferay.portal.kernel.model.change.tracking.CTModel<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
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.
CPOption| 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.
|
long |
getCtCollectionId()
Returns the ct collection ID 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 |
setCtCollectionId(long ctCollectionId)
Sets the ct collection ID 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.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlStringlong getPrimaryKey()
getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>void setPrimaryKey(long primaryKey)
setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>primaryKey - the primary key of this cp optionlong getMvccVersion()
getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelvoid setMvccVersion(long mvccVersion)
setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModelmvccVersion - the mvcc version of this cp optionlong getCtCollectionId()
getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>void setCtCollectionId(long ctCollectionId)
setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>ctCollectionId - the ct collection ID of this cp option@AutoEscape java.lang.String getUuid()
getUuid in interface com.liferay.portal.kernel.model.StagedModelvoid setUuid(java.lang.String uuid)
setUuid in interface com.liferay.portal.kernel.model.StagedModeluuid - the uuid of this cp option@AutoEscape java.lang.String getExternalReferenceCode()
void setExternalReferenceCode(java.lang.String externalReferenceCode)
externalReferenceCode - the external reference code of this cp optionlong getCPOptionId()
void setCPOptionId(long CPOptionId)
CPOptionId - the cp option ID of this cp optionlong getCompanyId()
getCompanyId in interface com.liferay.portal.kernel.model.AuditedModelgetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelgetCompanyId in interface com.liferay.portal.kernel.model.StagedModelvoid setCompanyId(long companyId)
setCompanyId in interface com.liferay.portal.kernel.model.AuditedModelsetCompanyId in interface com.liferay.portal.kernel.model.ShardedModelsetCompanyId in interface com.liferay.portal.kernel.model.StagedModelcompanyId - the company ID of this cp optionlong getUserId()
getUserId in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserId(long userId)
setUserId in interface com.liferay.portal.kernel.model.AuditedModeluserId - the user ID of this cp optionjava.lang.String getUserUuid()
getUserUuid in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserUuid(java.lang.String userUuid)
setUserUuid in interface com.liferay.portal.kernel.model.AuditedModeluserUuid - the user uuid of this cp option@AutoEscape java.lang.String getUserName()
getUserName in interface com.liferay.portal.kernel.model.AuditedModelvoid setUserName(java.lang.String userName)
setUserName in interface com.liferay.portal.kernel.model.AuditedModeluserName - the user name of this cp optionjava.util.Date getCreateDate()
getCreateDate in interface com.liferay.portal.kernel.model.AuditedModelgetCreateDate in interface com.liferay.portal.kernel.model.StagedModelvoid setCreateDate(java.util.Date createDate)
setCreateDate in interface com.liferay.portal.kernel.model.AuditedModelsetCreateDate in interface com.liferay.portal.kernel.model.StagedModelcreateDate - the create date of this cp optionjava.util.Date getModifiedDate()
getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelgetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelvoid setModifiedDate(java.util.Date modifiedDate)
setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModelsetModifiedDate in interface com.liferay.portal.kernel.model.StagedModelmodifiedDate - the modified date of this cp optionjava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getName(java.util.Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getName(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getName(java.lang.String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name - the name of this cp optionvoid setName(java.lang.String name,
java.util.Locale locale)
name - the localized name of this cp optionlocale - the locale of the languagevoid setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
name - the localized name of this cp optionlocale - the locale of the languagedefaultLocale - the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap - the locales and localized names of this cp optionvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Locale defaultLocale)
nameMap - the locales and localized names of this cp optiondefaultLocale - the default localejava.lang.String getDescription()
@AutoEscape java.lang.String getDescription(java.util.Locale locale)
locale - the locale of the language@AutoEscape
java.lang.String getDescription(java.util.Locale locale,
boolean useDefault)
locale - the local of the languageuseDefault - whether to use the default language if no localization exists for the requested languageuseDefault is false and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getDescription(java.lang.String languageId)
languageId - the ID of the language@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
boolean useDefault)
languageId - the ID of the languageuseDefault - whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getDescriptionCurrentLanguageId()
@AutoEscape java.lang.String getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()
void setDescription(java.lang.String description)
description - the description of this cp optionvoid setDescription(java.lang.String description,
java.util.Locale locale)
description - the localized description of this cp optionlocale - the locale of the languagevoid setDescription(java.lang.String description,
java.util.Locale locale,
java.util.Locale defaultLocale)
description - the localized description of this cp optionlocale - the locale of the languagedefaultLocale - the default localevoid setDescriptionCurrentLanguageId(java.lang.String languageId)
void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
descriptionMap - the locales and localized descriptions of this cp optionvoid setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.util.Locale defaultLocale)
descriptionMap - the locales and localized descriptions of this cp optiondefaultLocale - the default locale@AutoEscape java.lang.String getDDMFormFieldTypeName()
void setDDMFormFieldTypeName(java.lang.String DDMFormFieldTypeName)
DDMFormFieldTypeName - the ddm form field type name of this cp optionboolean getFacetable()
boolean isFacetable()
true if this cp option is facetable.true if this cp option is facetable; false otherwisevoid setFacetable(boolean facetable)
facetable - the facetable of this cp optionboolean getRequired()
boolean isRequired()
true if this cp option is required.true if this cp option is required; false otherwisevoid setRequired(boolean required)
required - the required of this cp optionboolean getSkuContributor()
boolean isSkuContributor()
true if this cp option is sku contributor.true if this cp option is sku contributor; false otherwisevoid setSkuContributor(boolean skuContributor)
skuContributor - the sku contributor of this cp option@AutoEscape java.lang.String getKey()
void setKey(java.lang.String key)
key - the key of this cp optionjava.util.Date getLastPublishDate()
void setLastPublishDate(java.util.Date lastPublishDate)
lastPublishDate - the last publish date of this cp optionjava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModeljava.lang.String getDefaultLanguageId()
getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModelvoid prepareLocalizedFieldsForImport()
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleExceptionvoid prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModelcom.liferay.portal.kernel.exception.LocaleException