Package com.liferay.asset.kernel.model
Interface AssetCategoryModel
- All Superinterfaces:
AuditedModel
,BaseModel<AssetCategory>
,ClassedModel
,Cloneable
,Comparable<AssetCategory>
,CTModel<AssetCategory>
,ExternalReferenceCodeModel
,GroupedModel
,LocalizedModel
,MVCCModel
,Serializable
,ShardedModel
,StagedGroupedModel
,StagedModel
- All Known Subinterfaces:
AssetCategory
- All Known Implementing Classes:
AssetCategoryWrapper
@ProviderType
public interface AssetCategoryModel
extends BaseModel<AssetCategory>, CTModel<AssetCategory>, ExternalReferenceCodeModel, LocalizedModel, MVCCModel, ShardedModel, StagedGroupedModel
The base model interface for the AssetCategory service. Represents a row in the "AssetCategory" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl
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.portlet.asset.model.impl.AssetCategoryImpl
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the category ID of this asset category.long
Returns the company ID of this asset category.Returns the create date of this asset category.long
Returns the ct collection ID of this asset category.Returns the description of this asset category.getDescription
(String languageId) Returns the localized description of this asset category in the language.getDescription
(String languageId, boolean useDefault) Returns the localized description of this asset 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 asset category in the language.getDescription
(Locale locale, boolean useDefault) Returns the localized description of this asset 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 asset category.Returns the external reference code of this asset category.long
Returns the group ID of this asset category.Returns the last publish date of this asset category.Returns the modified date of this asset category.long
Returns the mvcc version of this asset category.getName()
Returns the name of this asset category.long
Returns the parent category ID of this asset category.long
Returns the primary key of this asset category.getTitle()
Returns the title of this asset category.Returns the localized title of this asset category in the language.Returns the localized title of this asset category in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this asset category in the language.Returns the localized title of this asset 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 asset category.Returns the tree path of this asset category.long
Returns the user ID of this asset category.Returns the user name of this asset category.Returns the user uuid of this asset category.getUuid()
Returns the uuid of this asset category.long
Returns the vocabulary ID of this asset category.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCategoryId
(long categoryId) Sets the category ID of this asset category.void
setCompanyId
(long companyId) Sets the company ID of this asset category.void
setCreateDate
(Date createDate) Sets the create date of this asset category.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this asset category.void
setDescription
(String description) Sets the description of this asset category.void
setDescription
(String description, Locale locale) Sets the localized description of this asset category in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this asset 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 asset category from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this asset 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 asset category.void
setGroupId
(long groupId) Sets the group ID of this asset category.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this asset category.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this asset category.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this asset category.void
Sets the name of this asset category.void
setParentCategoryId
(long parentCategoryId) Sets the parent category ID of this asset category.void
setPrimaryKey
(long primaryKey) Sets the primary key of this asset category.void
Sets the title of this asset category.void
Sets the localized title of this asset category in the language.void
Sets the localized title of this asset 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 asset category from the map of locales and localized titles.void
setTitleMap
(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this asset category from the map of locales and localized titles, and sets the default locale.void
setTreePath
(String treePath) Sets the tree path of this asset category.void
setUserId
(long userId) Sets the user ID of this asset category.void
setUserName
(String userName) Sets the user name of this asset category.void
setUserUuid
(String userUuid) Sets the user uuid of this asset category.void
Sets the uuid of this asset category.void
setVocabularyId
(long vocabularyId) Sets the vocabulary ID of this asset 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 asset category.- Specified by:
getPrimaryKey
in interfaceCTModel<AssetCategory>
- Returns:
- the primary key of this asset category
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this asset category.- Specified by:
setPrimaryKey
in interfaceCTModel<AssetCategory>
- Parameters:
primaryKey
- the primary key of this asset category
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this asset category.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this asset category
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this asset category.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this asset category
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this asset category.- Specified by:
getCtCollectionId
in interfaceCTModel<AssetCategory>
- Returns:
- the ct collection ID of this asset category
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this asset category.- Specified by:
setCtCollectionId
in interfaceCTModel<AssetCategory>
- Parameters:
ctCollectionId
- the ct collection ID of this asset category
-
getUuid
Returns the uuid of this asset category.- Specified by:
getUuid
in interfaceStagedModel
- Returns:
- the uuid of this asset category
-
setUuid
Sets the uuid of this asset category.- Specified by:
setUuid
in interfaceStagedModel
- Parameters:
uuid
- the uuid of this asset category
-
getExternalReferenceCode
Returns the external reference code of this asset category.- Specified by:
getExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Returns:
- the external reference code of this asset category
-
setExternalReferenceCode
Sets the external reference code of this asset category.- Specified by:
setExternalReferenceCode
in interfaceExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this asset category
-
getCategoryId
long getCategoryId()Returns the category ID of this asset category.- Returns:
- the category ID of this asset category
-
setCategoryId
void setCategoryId(long categoryId) Sets the category ID of this asset category.- Parameters:
categoryId
- the category ID of this asset category
-
getGroupId
long getGroupId()Returns the group ID of this asset category.- Specified by:
getGroupId
in interfaceGroupedModel
- Returns:
- the group ID of this asset category
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this asset category.- Specified by:
setGroupId
in interfaceGroupedModel
- Parameters:
groupId
- the group ID of this asset category
-
getCompanyId
long getCompanyId()Returns the company ID of this asset category.- Specified by:
getCompanyId
in interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Specified by:
getCompanyId
in interfaceStagedModel
- Returns:
- the company ID of this asset category
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this asset category.- Specified by:
setCompanyId
in interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Specified by:
setCompanyId
in interfaceStagedModel
- Parameters:
companyId
- the company ID of this asset category
-
getUserId
long getUserId()Returns the user ID of this asset category.- Specified by:
getUserId
in interfaceAuditedModel
- Returns:
- the user ID of this asset category
-
setUserId
void setUserId(long userId) Sets the user ID of this asset category.- Specified by:
setUserId
in interfaceAuditedModel
- Parameters:
userId
- the user ID of this asset category
-
getUserUuid
String getUserUuid()Returns the user uuid of this asset category.- Specified by:
getUserUuid
in interfaceAuditedModel
- Returns:
- the user uuid of this asset category
-
setUserUuid
Sets the user uuid of this asset category.- Specified by:
setUserUuid
in interfaceAuditedModel
- Parameters:
userUuid
- the user uuid of this asset category
-
getUserName
Returns the user name of this asset category.- Specified by:
getUserName
in interfaceAuditedModel
- Returns:
- the user name of this asset category
-
setUserName
Sets the user name of this asset category.- Specified by:
setUserName
in interfaceAuditedModel
- Parameters:
userName
- the user name of this asset category
-
getCreateDate
Date getCreateDate()Returns the create date of this asset category.- Specified by:
getCreateDate
in interfaceAuditedModel
- Specified by:
getCreateDate
in interfaceStagedModel
- Returns:
- the create date of this asset category
-
setCreateDate
Sets the create date of this asset category.- Specified by:
setCreateDate
in interfaceAuditedModel
- Specified by:
setCreateDate
in interfaceStagedModel
- Parameters:
createDate
- the create date of this asset category
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this asset category.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Specified by:
getModifiedDate
in interfaceStagedModel
- Returns:
- the modified date of this asset category
-
setModifiedDate
Sets the modified date of this asset category.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Specified by:
setModifiedDate
in interfaceStagedModel
- Parameters:
modifiedDate
- the modified date of this asset category
-
getParentCategoryId
long getParentCategoryId()Returns the parent category ID of this asset category.- Returns:
- the parent category ID of this asset category
-
setParentCategoryId
void setParentCategoryId(long parentCategoryId) Sets the parent category ID of this asset category.- Parameters:
parentCategoryId
- the parent category ID of this asset category
-
getTreePath
Returns the tree path of this asset category.- Returns:
- the tree path of this asset category
-
setTreePath
Sets the tree path of this asset category.- Parameters:
treePath
- the tree path of this asset category
-
getName
Returns the name of this asset category.- Returns:
- the name of this asset category
-
setName
Sets the name of this asset category.- Parameters:
name
- the name of this asset category
-
getTitle
String getTitle()Returns the title of this asset category.- Returns:
- the title of this asset category
-
getTitle
Returns the localized title of this asset 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 asset category
-
getTitle
Returns the localized title of this asset 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 asset 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 asset 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 asset category
-
getTitle
Returns the localized title of this asset 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 asset category
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this asset category.- Returns:
- the locales and localized titles of this asset category
-
setTitle
Sets the title of this asset category.- Parameters:
title
- the title of this asset category
-
setTitle
Sets the localized title of this asset category in the language.- Parameters:
title
- the localized title of this asset categorylocale
- the locale of the language
-
setTitle
Sets the localized title of this asset category in the language, and sets the default locale.- Parameters:
title
- the localized title of this asset categorylocale
- the locale of the languagedefaultLocale
- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this asset category from the map of locales and localized titles.- Parameters:
titleMap
- the locales and localized titles of this asset category
-
setTitleMap
Sets the localized titles of this asset category from the map of locales and localized titles, and sets the default locale.- Parameters:
titleMap
- the locales and localized titles of this asset categorydefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this asset category.- Returns:
- the description of this asset category
-
getDescription
Returns the localized description of this asset 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 asset category
-
getDescription
Returns the localized description of this asset 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 asset 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 asset 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 asset category
-
getDescription
Returns the localized description of this asset 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 asset category
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this asset category.- Returns:
- the locales and localized descriptions of this asset category
-
setDescription
Sets the description of this asset category.- Parameters:
description
- the description of this asset category
-
setDescription
Sets the localized description of this asset category in the language.- Parameters:
description
- the localized description of this asset categorylocale
- the locale of the language
-
setDescription
Sets the localized description of this asset category in the language, and sets the default locale.- Parameters:
description
- the localized description of this asset categorylocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this asset category from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this asset category
-
setDescriptionMap
Sets the localized descriptions of this asset category from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this asset categorydefaultLocale
- the default locale
-
getVocabularyId
long getVocabularyId()Returns the vocabulary ID of this asset category.- Returns:
- the vocabulary ID of this asset category
-
setVocabularyId
void setVocabularyId(long vocabularyId) Sets the vocabulary ID of this asset category.- Parameters:
vocabularyId
- the vocabulary ID of this asset category
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this asset category.- Specified by:
getLastPublishDate
in interfaceStagedGroupedModel
- Returns:
- the last publish date of this asset category
-
setLastPublishDate
Sets the last publish date of this asset category.- Specified by:
setLastPublishDate
in interfaceStagedGroupedModel
- Parameters:
lastPublishDate
- the last publish date of this asset category
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImport
in interfaceLocalizedModel
- Throws:
LocaleException
-
cloneWithOriginalValues
AssetCategory cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<AssetCategory>
-
toXmlString
-