com.liferay.commerce.product.model

Interface CPOptionCategoryModel

All Superinterfaces:

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

CPOptionCategory

All Known Implementing Classes:

CPOptionCategoryWrapper

@ProviderType
public interface CPOptionCategoryModel
extends com.liferay.portal.kernel.model.BaseModel<CPOptionCategory>, 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:

CPOptionCategory

Generated:

Method Summary

Modifier and Type	Method and Description
CPOptionCategory	cloneWithOriginalValues()
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this cp option category.
long	getCPOptionCategoryId() Returns the cp option category ID of this cp option category.
java.util.Date	getCreateDate() Returns the create date of this cp option category.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this cp option category.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this cp option category in the language.
java.lang.String	getDescription(java.util.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.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this cp option category in the language.
java.lang.String	getDescription(java.lang.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.
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 category.
java.lang.String	getKey() Returns the key of this cp option category.
java.util.Date	getLastPublishDate() Returns the last publish date of this cp option category.
java.util.Date	getModifiedDate() Returns the modified date of this cp option category.
long	getMvccVersion() Returns the mvcc version of this cp option category.
long	getPrimaryKey() Returns the primary key of this cp option category.
double	getPriority() Returns the priority of this cp option category.
java.lang.String	getTitle() Returns the title of this cp option category.
java.lang.String	getTitle(java.util.Locale locale) Returns the localized title of this cp option category in the language.
java.lang.String	getTitle(java.util.Locale locale, boolean useDefault) 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.
java.lang.String	getTitle(java.lang.String languageId) Returns the localized title of this cp option category in the language.
java.lang.String	getTitle(java.lang.String languageId, boolean useDefault) 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.
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 option category.
long	getUserId() Returns the user ID of this cp option category.
java.lang.String	getUserName() Returns the user name of this cp option category.
java.lang.String	getUserUuid() Returns the user uuid of this cp option category.
java.lang.String	getUuid() Returns the uuid of this cp option category.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.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(java.util.Date createDate) Sets the create date of this cp option category.
void	setDescription(java.lang.String description) Sets the description of this cp option category.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this cp option category 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 category 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 category 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 category from the map of locales and localized descriptions, and sets the default locale.
void	setKey(java.lang.String key) Sets the key of this cp option category.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this cp option category.
void	setModifiedDate(java.util.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	setTitle(java.lang.String title) Sets the title of this cp option category.
void	setTitle(java.lang.String title, java.util.Locale locale) Sets the localized title of this cp option category in the language.
void	setTitle(java.lang.String title, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized title of this cp option category 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 option category 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 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(java.lang.String userName) Sets the user name of this cp option category.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this cp option category.
void	setUuid(java.lang.String uuid) Sets the uuid of this cp option category.

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 category.

Returns:

the primary key of this cp option category

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this cp option category.

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 interface com.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 interface com.liferay.portal.kernel.model.MVCCModel

Parameters:

mvccVersion - the mvcc version of this cp option category

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this cp option category.

Specified by:

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

Returns:

the uuid of this cp option category

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this cp option category.

Specified by:

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

Parameters:

uuid - the uuid 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 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 category

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this cp option category.

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 category

getUserId

long getUserId()

Returns the user ID of this cp option category.

Specified by:

getUserId in interface com.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 interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userId - the user ID of this cp option category

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this cp option category.

Specified by:

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

Returns:

the user uuid of this cp option category

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this cp option category.

Specified by:

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

Parameters:

userUuid - the user uuid of this cp option category

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this cp option category.

Specified by:

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

Returns:

the user name of this cp option category

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this cp option category.

Specified by:

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

Parameters:

userName - the user name of this cp option category

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this cp option category.

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 category

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this cp option category.

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 category

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this cp option category.

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 category

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this cp option category.

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 category

getTitle

java.lang.String getTitle()

Returns the title of this cp option category.

Returns:

the title of this cp option category

getTitle

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

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

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

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 language

useDefault - 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 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 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

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

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 language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized title of this cp option category

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

Returns:

the locales and localized titles of this cp option category

setTitle

void setTitle(java.lang.String title)

Sets the title of this cp option category.

Parameters:

title - the title of this cp option category

setTitle

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

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

Parameters:

title - the localized title of this cp option category

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

Parameters:

title - the localized title of this cp option category

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

Parameters:

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

setTitleMap

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

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 category

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this cp option category.

Returns:

the description of this cp option category

getDescription

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

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

@AutoEscape
java.lang.String getDescription(java.util.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.

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 category. 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 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

@AutoEscape
java.lang.String getDescription(java.lang.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.

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 category

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 category.

Returns:

the locales and localized descriptions of this cp option category

setDescription

void setDescription(java.lang.String description)

Sets the description of this cp option category.

Parameters:

description - the description of this cp option category

setDescription

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

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

Parameters:

description - the localized description of this cp option category

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

Parameters:

description - the localized description of this cp option category

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

Parameters:

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

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 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 category

defaultLocale - 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

@AutoEscape
java.lang.String getKey()

Returns the key of this cp option category.

Returns:

the key of this cp option category

setKey

void setKey(java.lang.String key)

Sets the key of this cp option category.

Parameters:

key - the key of this cp option category

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this cp option category.

Returns:

the last publish date of this cp option category

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this cp option category.

Parameters:

lastPublishDate - the last publish date of this cp option category

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

CPOptionCategory cloneWithOriginalValues()

Specified by:

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