Interface CPOptionModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<CPOption>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<CPOption>
,com.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,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.change.tracking.CTModel<CPOption>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, 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:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the commerce option type key of this cp option.long
Returns the company ID of this cp option.long
Returns the cp option ID of this cp option.Returns the create date of this cp option.long
Returns the ct collection ID of this cp option.Returns the description of this cp option.getDescription
(String languageId) Returns the localized description of this cp option in the language.getDescription
(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.getDescription
(Locale locale) Returns the localized description of this cp option in the language.getDescription
(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.Returns a map of the locales and localized descriptions of this cp option.Returns the external reference code of this cp option.boolean
Returns the facetable of this cp option.getKey()
Returns the key of this cp option.Returns the last publish date of this cp option.Returns the modified date of this cp option.long
Returns the mvcc version of this cp option.getName()
Returns the name of this cp option.Returns the localized name of this cp option in the language.Returns the localized name of this cp option in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this cp option in the language.Returns the localized name of this cp option in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this cp option.long
Returns the primary key of this cp option.boolean
Returns the required of this cp option.boolean
Returns the sku contributor of this cp option.long
Returns the user ID of this cp option.Returns the user name of this cp option.Returns the user uuid of this cp option.getUuid()
Returns the uuid of this cp option.boolean
Returnstrue
if this cp option is facetable.boolean
Returnstrue
if this cp option is required.boolean
Returnstrue
if this cp option is sku contributor.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCommerceOptionTypeKey
(String commerceOptionTypeKey) Sets the commerce option type key of this cp option.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
(Date createDate) Sets the create date of this cp option.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this cp option.void
setDescription
(String description) Sets the description of this cp option.void
setDescription
(String description, Locale locale) Sets the localized description of this cp option in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this cp option in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this cp option from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, 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
(String externalReferenceCode) Sets the external reference code of this cp option.void
setFacetable
(boolean facetable) Sets whether this cp option is facetable.void
Sets the key of this cp option.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this cp option.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this cp option.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this cp option.void
Sets the name of this cp option.void
Sets the localized name of this cp option in the language.void
Sets the localized name of this cp option in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this cp option from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, 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
(String userName) Sets the user name of this cp option.void
setUserUuid
(String userUuid) Sets the user uuid of this cp option.void
Sets the uuid of this cp option.default String
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
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this cp option.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>
- Returns:
- the primary key of this cp option
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this cp option.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>
- Parameters:
primaryKey
- the primary key of this cp option
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this cp option.- Specified by:
getMvccVersion
in interfacecom.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 interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this cp option
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this cp option.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>
- Returns:
- the ct collection ID of this cp option
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this cp option.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOption>
- Parameters:
ctCollectionId
- the ct collection ID of this cp option
-
getUuid
Returns the uuid of this cp option.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this cp option
-
setUuid
Sets the uuid of this cp option.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this cp option
-
getExternalReferenceCode
Returns the external reference code of this cp option.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this cp option
-
setExternalReferenceCode
Sets the external reference code of this cp option.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- 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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.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 interfacecom.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 interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this cp option
-
getUserUuid
String getUserUuid()Returns the user uuid of this cp option.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this cp option
-
setUserUuid
Sets the user uuid of this cp option.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this cp option
-
getUserName
Returns the user name of this cp option.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this cp option
-
setUserName
Sets the user name of this cp option.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this cp option
-
getCreateDate
Date getCreateDate()Returns the create date of this cp option.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this cp option
-
setCreateDate
Sets the create date of this cp option.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this cp option
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this cp option.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this cp option
-
setModifiedDate
Sets the modified date of this cp option.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this cp option
-
getName
String getName()Returns the name of this cp option.- Returns:
- the name of this cp option
-
getName
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this cp option. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this cp option
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
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
Sets the name of this cp option.- Parameters:
name
- the name of this cp option
-
setName
Sets the localized name of this cp option in the language.- Parameters:
name
- the localized name of this cp optionlocale
- the locale of the language
-
setName
Sets the localized name of this cp option in the language, and sets the default locale.- Parameters:
name
- the localized name of this cp optionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
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
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 optiondefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this cp option.- Returns:
- the description of this cp option
-
getDescription
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this cp option. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
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
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 languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this cp option
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
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
Sets the description of this cp option.- Parameters:
description
- the description of this cp option
-
setDescription
Sets the localized description of this cp option in the language.- Parameters:
description
- the localized description of this cp optionlocale
- the locale of the language
-
setDescription
Sets the localized description of this cp option in the language, and sets the default locale.- Parameters:
description
- the localized description of this cp optionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
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
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 optiondefaultLocale
- the default locale
-
getCommerceOptionTypeKey
Returns the commerce option type key of this cp option.- Returns:
- the commerce option type key of this cp option
-
setCommerceOptionTypeKey
Sets the commerce option type key of this cp option.- Parameters:
commerceOptionTypeKey
- the commerce option type key of this cp option
-
getFacetable
boolean getFacetable()Returns the facetable of this cp option.- Returns:
- the facetable of this cp option
-
isFacetable
boolean isFacetable()Returnstrue
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()Returnstrue
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()Returnstrue
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
Returns the key of this cp option.- Returns:
- the key of this cp option
-
setKey
Sets the key of this cp option.- Parameters:
key
- the key of this cp option
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this cp option.- Returns:
- the last publish date of this cp option
-
setLastPublishDate
Sets the last publish date of this cp option.- Parameters:
lastPublishDate
- the last publish date of this cp option
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
CPOption cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<CPOption>
-
toXmlString
-