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[]longReturns the category ID of this asset category.longReturns the company ID of this asset category.Returns the create date of this asset category.longReturns 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.longReturns the group ID of this asset category.Returns the last publish date of this asset category.Returns the modified date of this asset category.longReturns the mvcc version of this asset category.getName()Returns the name of this asset category.longReturns the parent category ID of this asset category.longReturns 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.longReturns 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.longReturns the vocabulary ID of this asset category.voidvoidprepareLocalizedFieldsForImport(Locale defaultImportLocale) voidsetCategoryId(long categoryId) Sets the category ID of this asset category.voidsetCompanyId(long companyId) Sets the company ID of this asset category.voidsetCreateDate(Date createDate) Sets the create date of this asset category.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this asset category.voidsetDescription(String description) Sets the description of this asset category.voidsetDescription(String description, Locale locale) Sets the localized description of this asset category in the language.voidsetDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this asset category in the language, and sets the default locale.voidsetDescriptionCurrentLanguageId(String languageId) voidsetDescriptionMap(Map<Locale, String> descriptionMap) Sets the localized descriptions of this asset category from the map of locales and localized descriptions.voidsetDescriptionMap(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.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this asset category.voidsetGroupId(long groupId) Sets the group ID of this asset category.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this asset category.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this asset category.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this asset category.voidSets the name of this asset category.voidsetParentCategoryId(long parentCategoryId) Sets the parent category ID of this asset category.voidsetPrimaryKey(long primaryKey) Sets the primary key of this asset category.voidSets the title of this asset category.voidSets the localized title of this asset category in the language.voidSets the localized title of this asset category in the language, and sets the default locale.voidsetTitleCurrentLanguageId(String languageId) voidsetTitleMap(Map<Locale, String> titleMap) Sets the localized titles of this asset category from the map of locales and localized titles.voidsetTitleMap(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.voidsetTreePath(String treePath) Sets the tree path of this asset category.voidsetUserId(long userId) Sets the user ID of this asset category.voidsetUserName(String userName) Sets the user name of this asset category.voidsetUserUuid(String userUuid) Sets the user uuid of this asset category.voidSets the uuid of this asset category.voidsetVocabularyId(long vocabularyId) Sets the vocabulary ID of this asset category.default StringMethods 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, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods 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:
getPrimaryKeyin 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:
setPrimaryKeyin interfaceCTModel<AssetCategory>- Parameters:
primaryKey- the primary key of this asset category
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this asset category.- Specified by:
getMvccVersionin interfaceMVCCModel- Returns:
- the mvcc version of this asset category
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this asset category.- Specified by:
setMvccVersionin interfaceMVCCModel- Parameters:
mvccVersion- the mvcc version of this asset category
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this asset category.- Specified by:
getCtCollectionIdin 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:
setCtCollectionIdin interfaceCTModel<AssetCategory>- Parameters:
ctCollectionId- the ct collection ID of this asset category
-
getUuid
Returns the uuid of this asset category.- Specified by:
getUuidin interfaceStagedModel- Returns:
- the uuid of this asset category
-
setUuid
Sets the uuid of this asset category.- Specified by:
setUuidin interfaceStagedModel- Parameters:
uuid- the uuid of this asset category
-
getExternalReferenceCode
Returns the external reference code of this asset category.- Specified by:
getExternalReferenceCodein interfaceExternalReferenceCodeModel- Returns:
- the external reference code of this asset category
-
setExternalReferenceCode
Sets the external reference code of this asset category.- Specified by:
setExternalReferenceCodein 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:
getGroupIdin interfaceGroupedModel- Returns:
- the group ID of this asset category
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this asset category.- Specified by:
setGroupIdin interfaceGroupedModel- Parameters:
groupId- the group ID of this asset category
-
getCompanyId
long getCompanyId()Returns the company ID of this asset category.- Specified by:
getCompanyIdin interfaceAuditedModel- Specified by:
getCompanyIdin interfaceShardedModel- Specified by:
getCompanyIdin interfaceStagedModel- Returns:
- the company ID of this asset category
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this asset category.- Specified by:
setCompanyIdin interfaceAuditedModel- Specified by:
setCompanyIdin interfaceShardedModel- Specified by:
setCompanyIdin interfaceStagedModel- Parameters:
companyId- the company ID of this asset category
-
getUserId
long getUserId()Returns the user ID of this asset category.- Specified by:
getUserIdin interfaceAuditedModel- Returns:
- the user ID of this asset category
-
setUserId
void setUserId(long userId) Sets the user ID of this asset category.- Specified by:
setUserIdin interfaceAuditedModel- Parameters:
userId- the user ID of this asset category
-
getUserUuid
String getUserUuid()Returns the user uuid of this asset category.- Specified by:
getUserUuidin interfaceAuditedModel- Returns:
- the user uuid of this asset category
-
setUserUuid
Sets the user uuid of this asset category.- Specified by:
setUserUuidin interfaceAuditedModel- Parameters:
userUuid- the user uuid of this asset category
-
getUserName
Returns the user name of this asset category.- Specified by:
getUserNamein interfaceAuditedModel- Returns:
- the user name of this asset category
-
setUserName
Sets the user name of this asset category.- Specified by:
setUserNamein interfaceAuditedModel- Parameters:
userName- the user name of this asset category
-
getCreateDate
Date getCreateDate()Returns the create date of this asset category.- Specified by:
getCreateDatein interfaceAuditedModel- Specified by:
getCreateDatein interfaceStagedModel- Returns:
- the create date of this asset category
-
setCreateDate
Sets the create date of this asset category.- Specified by:
setCreateDatein interfaceAuditedModel- Specified by:
setCreateDatein interfaceStagedModel- Parameters:
createDate- the create date of this asset category
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this asset category.- Specified by:
getModifiedDatein interfaceAuditedModel- Specified by:
getModifiedDatein interfaceStagedModel- Returns:
- the modified date of this asset category
-
setModifiedDate
Sets the modified date of this asset category.- Specified by:
setModifiedDatein interfaceAuditedModel- Specified by:
setModifiedDatein 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
useDefaultisfalseand 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
useDefaultisfalseand 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:
getLastPublishDatein interfaceStagedGroupedModel- Returns:
- the last publish date of this asset category
-
setLastPublishDate
Sets the last publish date of this asset category.- Specified by:
setLastPublishDatein interfaceStagedGroupedModel- Parameters:
lastPublishDate- the last publish date of this asset category
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIdsin interfaceLocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageIdin interfaceLocalizedModel
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
prepareLocalizedFieldsForImport
- Specified by:
prepareLocalizedFieldsForImportin interfaceLocalizedModel- Throws:
LocaleException
-
cloneWithOriginalValues
AssetCategory cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfaceBaseModel<AssetCategory>
-
toXmlString
-