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