Interface CPOptionCategoryModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<CPOptionCategory>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<CPOptionCategory>
,com.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>
,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:
CPOptionCategory
- All Known Implementing Classes:
CPOptionCategoryWrapper
@ProviderType
public interface CPOptionCategoryModel
extends com.liferay.portal.kernel.model.BaseModel<CPOptionCategory>, com.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>, 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 CPOptionCategory service. Represents a row in the "CPOptionCategory" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.commerce.product.model.impl.CPOptionCategoryModelImpl
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.CPOptionCategoryImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the company ID of this cp option category.long
Returns the cp option category ID of this cp option category.Returns the create date of this cp option category.long
Returns the ct collection ID of this cp option category.Returns the description of this cp option category.getDescription
(String languageId) Returns the localized description of this cp option category in the language.getDescription
(String languageId, boolean useDefault) Returns the localized description of this cp option category 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 category in the language.getDescription
(Locale locale, boolean useDefault) Returns the localized description of this cp option category 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 category.Returns the external reference code of this cp option category.getKey()
Returns the key of this cp option category.Returns the last publish date of this cp option category.Returns the modified date of this cp option category.long
Returns the mvcc version of this cp option category.long
Returns the primary key of this cp option category.double
Returns the priority of this cp option category.getTitle()
Returns the title of this cp option category.Returns the localized title of this cp option category in the language.Returns the localized title of this cp option category in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this cp option category in the language.Returns the localized title of this cp option category in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized titles of this cp option category.long
Returns the user ID of this cp option category.Returns the user name of this cp option category.Returns the user uuid of this cp option category.getUuid()
Returns the uuid of this cp option category.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCompanyId
(long companyId) Sets the company ID of this cp option category.void
setCPOptionCategoryId
(long CPOptionCategoryId) Sets the cp option category ID of this cp option category.void
setCreateDate
(Date createDate) Sets the create date of this cp option category.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this cp option category.void
setDescription
(String description) Sets the description of this cp option category.void
setDescription
(String description, Locale locale) Sets the localized description of this cp option category in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this cp option category 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 category from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this cp option category 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 category.void
Sets the key of this cp option category.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this cp option category.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this cp option category.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this cp option category.void
setPrimaryKey
(long primaryKey) Sets the primary key of this cp option category.void
setPriority
(double priority) Sets the priority of this cp option category.void
Sets the title of this cp option category.void
Sets the localized title of this cp option category in the language.void
Sets the localized title of this cp option category in the language, and sets the default locale.void
setTitleCurrentLanguageId
(String languageId) void
setTitleMap
(Map<Locale, String> titleMap) Sets the localized titles of this cp option category from the map of locales and localized titles.void
setTitleMap
(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this cp option category from the map of locales and localized titles, and sets the default locale.void
setUserId
(long userId) Sets the user ID of this cp option category.void
setUserName
(String userName) Sets the user name of this cp option category.void
setUserUuid
(String userUuid) Sets the user uuid of this cp option category.void
Sets the uuid of this cp option category.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 category.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>
- Returns:
- the primary key of this cp option category
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this cp option category.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>
- Parameters:
primaryKey
- the primary key of this cp option category
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this cp option category.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this cp option category
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this cp option category.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this cp option category
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this cp option category.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>
- Returns:
- the ct collection ID of this cp option category
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this cp option category.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<CPOptionCategory>
- Parameters:
ctCollectionId
- the ct collection ID of this cp option category
-
getUuid
Returns the uuid of this cp option category.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this cp option category
-
setUuid
Sets the uuid of this cp option category.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this cp option category
-
getExternalReferenceCode
Returns the external reference code of this cp option category.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this cp option category
-
setExternalReferenceCode
Sets the external reference code of this cp option category.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this cp option category
-
getCPOptionCategoryId
long getCPOptionCategoryId()Returns the cp option category ID of this cp option category.- Returns:
- the cp option category ID of this cp option category
-
setCPOptionCategoryId
void setCPOptionCategoryId(long CPOptionCategoryId) Sets the cp option category ID of this cp option category.- Parameters:
CPOptionCategoryId
- the cp option category ID of this cp option category
-
getCompanyId
long getCompanyId()Returns the company ID of this cp option category.- 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 category
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this cp option category.- 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 category
-
getUserId
long getUserId()Returns the user ID of this cp option category.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this cp option category
-
setUserId
void setUserId(long userId) Sets the user ID of this cp option category.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this cp option category
-
getUserUuid
String getUserUuid()Returns the user uuid of this cp option category.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this cp option category
-
setUserUuid
Sets the user uuid of this cp option category.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this cp option category
-
getUserName
Returns the user name of this cp option category.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this cp option category
-
setUserName
Sets the user name of this cp option category.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this cp option category
-
getCreateDate
Date getCreateDate()Returns the create date of this cp option category.- 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 category
-
setCreateDate
Sets the create date of this cp option category.- 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 category
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this cp option category.- 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 category
-
setModifiedDate
Sets the modified date of this cp option category.- 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 category
-
getTitle
String getTitle()Returns the title of this cp option category.- Returns:
- the title of this cp option category
-
getTitle
Returns the localized title of this cp option category 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 option category
-
getTitle
Returns the localized title of this cp option category 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 title of this cp option category. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getTitle
Returns the localized title of this cp option category 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 option category
-
getTitle
Returns the localized title of this cp option category 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 title of this cp option category
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this cp option category.- Returns:
- the locales and localized titles of this cp option category
-
setTitle
Sets the title of this cp option category.- Parameters:
title
- the title of this cp option category
-
setTitle
Sets the localized title of this cp option category in the language.- Parameters:
title
- the localized title of this cp option categorylocale
- the locale of the language
-
setTitle
Sets the localized title of this cp option category in the language, and sets the default locale.- Parameters:
title
- the localized title of this cp option categorylocale
- the locale of the languagedefaultLocale
- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this cp option category from the map of locales and localized titles.- Parameters:
titleMap
- the locales and localized titles of this cp option category
-
setTitleMap
Sets the localized titles of this cp option category from the map of locales and localized titles, and sets the default locale.- Parameters:
titleMap
- the locales and localized titles of this cp option categorydefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this cp option category.- Returns:
- the description of this cp option category
-
getDescription
Returns the localized description of this cp option category 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 category
-
getDescription
Returns the localized description of this cp option category 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 category. 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 category 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 category
-
getDescription
Returns the localized description of this cp option category 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 category
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this cp option category.- Returns:
- the locales and localized descriptions of this cp option category
-
setDescription
Sets the description of this cp option category.- Parameters:
description
- the description of this cp option category
-
setDescription
Sets the localized description of this cp option category in the language.- Parameters:
description
- the localized description of this cp option categorylocale
- the locale of the language
-
setDescription
Sets the localized description of this cp option category in the language, and sets the default locale.- Parameters:
description
- the localized description of this cp option categorylocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this cp option category from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this cp option category
-
setDescriptionMap
Sets the localized descriptions of this cp option category from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this cp option categorydefaultLocale
- the default locale
-
getPriority
double getPriority()Returns the priority of this cp option category.- Returns:
- the priority of this cp option category
-
setPriority
void setPriority(double priority) Sets the priority of this cp option category.- Parameters:
priority
- the priority of this cp option category
-
getKey
Returns the key of this cp option category.- Returns:
- the key of this cp option category
-
setKey
Sets the key of this cp option category.- Parameters:
key
- the key of this cp option category
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this cp option category.- Returns:
- the last publish date of this cp option category
-
setLastPublishDate
Sets the last publish date of this cp option category.- Parameters:
lastPublishDate
- the last publish date of this cp option category
-
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
CPOptionCategory cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<CPOptionCategory>
-
toXmlString
-