Package com.liferay.asset.kernel.model
Interface AssetEntryModel
- All Superinterfaces:
AttachedModel
,AuditedModel
,BaseModel<AssetEntry>
,ClassedModel
,Cloneable
,Comparable<AssetEntry>
,CTModel<AssetEntry>
,GroupedModel
,LocalizedModel
,MVCCModel
,Serializable
,ShardedModel
,TypedModel
- All Known Subinterfaces:
AssetEntry
- All Known Implementing Classes:
AssetEntryWrapper
@ProviderType
public interface AssetEntryModel
extends AttachedModel, BaseModel<AssetEntry>, CTModel<AssetEntry>, GroupedModel, LocalizedModel, MVCCModel, ShardedModel
The base model interface for the AssetEntry service. Represents a row in the "AssetEntry" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.portlet.asset.model.impl.AssetEntryModelImpl
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.AssetEntryImpl
.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the fully qualified class name of this asset entry.long
Returns the class name ID of this asset entry.long
Returns the class pk of this asset entry.long
Returns the class type ID of this asset entry.Returns the class uuid of this asset entry.long
Returns the company ID of this asset entry.Returns the create date of this asset entry.long
Returns the ct collection ID of this asset entry.Returns the description of this asset entry.getDescription
(String languageId) Returns the localized description of this asset entry in the language.getDescription
(String languageId, boolean useDefault) Returns the localized description of this asset entry 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 entry in the language.getDescription
(Locale locale, boolean useDefault) Returns the localized description of this asset entry 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 entry.Returns the end date of this asset entry.long
Returns the entry ID of this asset entry.Returns the expiration date of this asset entry.long
Returns the group ID of this asset entry.int
Returns the height of this asset entry.Returns the layout uuid of this asset entry.boolean
Returns the listable of this asset entry.Returns the mime type of this asset entry.Returns the modified date of this asset entry.long
Returns the mvcc version of this asset entry.long
Returns the primary key of this asset entry.double
Returns the priority of this asset entry.Returns the publish date of this asset entry.Returns the start date of this asset entry.Returns the summary of this asset entry.getSummary
(String languageId) Returns the localized summary of this asset entry in the language.getSummary
(String languageId, boolean useDefault) Returns the localized summary of this asset entry in the language, optionally using the default language if no localization exists for the requested language.getSummary
(Locale locale) Returns the localized summary of this asset entry in the language.getSummary
(Locale locale, boolean useDefault) Returns the localized summary of this asset entry in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized summaries of this asset entry.getTitle()
Returns the title of this asset entry.Returns the localized title of this asset entry in the language.Returns the localized title of this asset entry in the language, optionally using the default language if no localization exists for the requested language.Returns the localized title of this asset entry in the language.Returns the localized title of this asset entry 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 entry.getUrl()
Returns the url of this asset entry.long
Returns the user ID of this asset entry.Returns the user name of this asset entry.Returns the user uuid of this asset entry.boolean
Returns the visible of this asset entry.int
getWidth()
Returns the width of this asset entry.boolean
Returnstrue
if this asset entry is listable.boolean
Returnstrue
if this asset entry is visible.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setClassName
(String className) void
setClassNameId
(long classNameId) Sets the class name ID of this asset entry.void
setClassPK
(long classPK) Sets the class pk of this asset entry.void
setClassTypeId
(long classTypeId) Sets the class type ID of this asset entry.void
setClassUuid
(String classUuid) Sets the class uuid of this asset entry.void
setCompanyId
(long companyId) Sets the company ID of this asset entry.void
setCreateDate
(Date createDate) Sets the create date of this asset entry.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this asset entry.void
setDescription
(String description) Sets the description of this asset entry.void
setDescription
(String description, Locale locale) Sets the localized description of this asset entry in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this asset entry 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 entry from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this asset entry from the map of locales and localized descriptions, and sets the default locale.void
setEndDate
(Date endDate) Sets the end date of this asset entry.void
setEntryId
(long entryId) Sets the entry ID of this asset entry.void
setExpirationDate
(Date expirationDate) Sets the expiration date of this asset entry.void
setGroupId
(long groupId) Sets the group ID of this asset entry.void
setHeight
(int height) Sets the height of this asset entry.void
setLayoutUuid
(String layoutUuid) Sets the layout uuid of this asset entry.void
setListable
(boolean listable) Sets whether this asset entry is listable.void
setMimeType
(String mimeType) Sets the mime type of this asset entry.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this asset entry.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this asset entry.void
setPrimaryKey
(long primaryKey) Sets the primary key of this asset entry.void
setPriority
(double priority) Sets the priority of this asset entry.void
setPublishDate
(Date publishDate) Sets the publish date of this asset entry.void
setStartDate
(Date startDate) Sets the start date of this asset entry.void
setSummary
(String summary) Sets the summary of this asset entry.void
setSummary
(String summary, Locale locale) Sets the localized summary of this asset entry in the language.void
setSummary
(String summary, Locale locale, Locale defaultLocale) Sets the localized summary of this asset entry in the language, and sets the default locale.void
setSummaryCurrentLanguageId
(String languageId) void
setSummaryMap
(Map<Locale, String> summaryMap) Sets the localized summaries of this asset entry from the map of locales and localized summaries.void
setSummaryMap
(Map<Locale, String> summaryMap, Locale defaultLocale) Sets the localized summaries of this asset entry from the map of locales and localized summaries, and sets the default locale.void
Sets the title of this asset entry.void
Sets the localized title of this asset entry in the language.void
Sets the localized title of this asset entry 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 entry from the map of locales and localized titles.void
setTitleMap
(Map<Locale, String> titleMap, Locale defaultLocale) Sets the localized titles of this asset entry from the map of locales and localized titles, and sets the default locale.void
Sets the url of this asset entry.void
setUserId
(long userId) Sets the user ID of this asset entry.void
setUserName
(String userName) Sets the user name of this asset entry.void
setUserUuid
(String userUuid) Sets the user uuid of this asset entry.void
setVisible
(boolean visible) Sets whether this asset entry is visible.void
setWidth
(int width) Sets the width of this asset entry.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
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this asset entry.- Specified by:
getPrimaryKey
in interfaceCTModel<AssetEntry>
- Returns:
- the primary key of this asset entry
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this asset entry.- Specified by:
setPrimaryKey
in interfaceCTModel<AssetEntry>
- Parameters:
primaryKey
- the primary key of this asset entry
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this asset entry.- Specified by:
getMvccVersion
in interfaceMVCCModel
- Returns:
- the mvcc version of this asset entry
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this asset entry.- Specified by:
setMvccVersion
in interfaceMVCCModel
- Parameters:
mvccVersion
- the mvcc version of this asset entry
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this asset entry.- Specified by:
getCtCollectionId
in interfaceCTModel<AssetEntry>
- Returns:
- the ct collection ID of this asset entry
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this asset entry.- Specified by:
setCtCollectionId
in interfaceCTModel<AssetEntry>
- Parameters:
ctCollectionId
- the ct collection ID of this asset entry
-
getEntryId
long getEntryId()Returns the entry ID of this asset entry.- Returns:
- the entry ID of this asset entry
-
setEntryId
void setEntryId(long entryId) Sets the entry ID of this asset entry.- Parameters:
entryId
- the entry ID of this asset entry
-
getGroupId
long getGroupId()Returns the group ID of this asset entry.- Specified by:
getGroupId
in interfaceGroupedModel
- Returns:
- the group ID of this asset entry
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this asset entry.- Specified by:
setGroupId
in interfaceGroupedModel
- Parameters:
groupId
- the group ID of this asset entry
-
getCompanyId
long getCompanyId()Returns the company ID of this asset entry.- Specified by:
getCompanyId
in interfaceAuditedModel
- Specified by:
getCompanyId
in interfaceShardedModel
- Returns:
- the company ID of this asset entry
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this asset entry.- Specified by:
setCompanyId
in interfaceAuditedModel
- Specified by:
setCompanyId
in interfaceShardedModel
- Parameters:
companyId
- the company ID of this asset entry
-
getUserId
long getUserId()Returns the user ID of this asset entry.- Specified by:
getUserId
in interfaceAuditedModel
- Returns:
- the user ID of this asset entry
-
setUserId
void setUserId(long userId) Sets the user ID of this asset entry.- Specified by:
setUserId
in interfaceAuditedModel
- Parameters:
userId
- the user ID of this asset entry
-
getUserUuid
String getUserUuid()Returns the user uuid of this asset entry.- Specified by:
getUserUuid
in interfaceAuditedModel
- Returns:
- the user uuid of this asset entry
-
setUserUuid
Sets the user uuid of this asset entry.- Specified by:
setUserUuid
in interfaceAuditedModel
- Parameters:
userUuid
- the user uuid of this asset entry
-
getUserName
Returns the user name of this asset entry.- Specified by:
getUserName
in interfaceAuditedModel
- Returns:
- the user name of this asset entry
-
setUserName
Sets the user name of this asset entry.- Specified by:
setUserName
in interfaceAuditedModel
- Parameters:
userName
- the user name of this asset entry
-
getCreateDate
Date getCreateDate()Returns the create date of this asset entry.- Specified by:
getCreateDate
in interfaceAuditedModel
- Returns:
- the create date of this asset entry
-
setCreateDate
Sets the create date of this asset entry.- Specified by:
setCreateDate
in interfaceAuditedModel
- Parameters:
createDate
- the create date of this asset entry
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this asset entry.- Specified by:
getModifiedDate
in interfaceAuditedModel
- Returns:
- the modified date of this asset entry
-
setModifiedDate
Sets the modified date of this asset entry.- Specified by:
setModifiedDate
in interfaceAuditedModel
- Parameters:
modifiedDate
- the modified date of this asset entry
-
getClassName
String getClassName()Returns the fully qualified class name of this asset entry.- Specified by:
getClassName
in interfaceTypedModel
- Returns:
- the fully qualified class name of this asset entry
-
setClassName
-
getClassNameId
long getClassNameId()Returns the class name ID of this asset entry.- Specified by:
getClassNameId
in interfaceTypedModel
- Returns:
- the class name ID of this asset entry
-
setClassNameId
void setClassNameId(long classNameId) Sets the class name ID of this asset entry.- Specified by:
setClassNameId
in interfaceTypedModel
- Parameters:
classNameId
- the class name ID of this asset entry
-
getClassPK
long getClassPK()Returns the class pk of this asset entry.- Specified by:
getClassPK
in interfaceAttachedModel
- Returns:
- the class pk of this asset entry
-
setClassPK
void setClassPK(long classPK) Sets the class pk of this asset entry.- Specified by:
setClassPK
in interfaceAttachedModel
- Parameters:
classPK
- the class pk of this asset entry
-
getClassUuid
Returns the class uuid of this asset entry.- Returns:
- the class uuid of this asset entry
-
setClassUuid
Sets the class uuid of this asset entry.- Parameters:
classUuid
- the class uuid of this asset entry
-
getClassTypeId
long getClassTypeId()Returns the class type ID of this asset entry.- Returns:
- the class type ID of this asset entry
-
setClassTypeId
void setClassTypeId(long classTypeId) Sets the class type ID of this asset entry.- Parameters:
classTypeId
- the class type ID of this asset entry
-
getListable
boolean getListable()Returns the listable of this asset entry.- Returns:
- the listable of this asset entry
-
isListable
boolean isListable()Returnstrue
if this asset entry is listable.- Returns:
true
if this asset entry is listable;false
otherwise
-
setListable
void setListable(boolean listable) Sets whether this asset entry is listable.- Parameters:
listable
- the listable of this asset entry
-
getVisible
boolean getVisible()Returns the visible of this asset entry.- Returns:
- the visible of this asset entry
-
isVisible
boolean isVisible()Returnstrue
if this asset entry is visible.- Returns:
true
if this asset entry is visible;false
otherwise
-
setVisible
void setVisible(boolean visible) Sets whether this asset entry is visible.- Parameters:
visible
- the visible of this asset entry
-
getStartDate
Date getStartDate()Returns the start date of this asset entry.- Returns:
- the start date of this asset entry
-
setStartDate
Sets the start date of this asset entry.- Parameters:
startDate
- the start date of this asset entry
-
getEndDate
Date getEndDate()Returns the end date of this asset entry.- Returns:
- the end date of this asset entry
-
setEndDate
Sets the end date of this asset entry.- Parameters:
endDate
- the end date of this asset entry
-
getPublishDate
Date getPublishDate()Returns the publish date of this asset entry.- Returns:
- the publish date of this asset entry
-
setPublishDate
Sets the publish date of this asset entry.- Parameters:
publishDate
- the publish date of this asset entry
-
getExpirationDate
Date getExpirationDate()Returns the expiration date of this asset entry.- Returns:
- the expiration date of this asset entry
-
setExpirationDate
Sets the expiration date of this asset entry.- Parameters:
expirationDate
- the expiration date of this asset entry
-
getMimeType
Returns the mime type of this asset entry.- Returns:
- the mime type of this asset entry
-
setMimeType
Sets the mime type of this asset entry.- Parameters:
mimeType
- the mime type of this asset entry
-
getTitle
String getTitle()Returns the title of this asset entry.- Returns:
- the title of this asset entry
-
getTitle
Returns the localized title of this asset entry 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 entry
-
getTitle
Returns the localized title of this asset entry 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 entry. 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 entry 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 entry
-
getTitle
Returns the localized title of this asset entry 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 entry
-
getTitleCurrentLanguageId
-
getTitleCurrentValue
-
getTitleMap
Returns a map of the locales and localized titles of this asset entry.- Returns:
- the locales and localized titles of this asset entry
-
setTitle
Sets the title of this asset entry.- Parameters:
title
- the title of this asset entry
-
setTitle
Sets the localized title of this asset entry in the language.- Parameters:
title
- the localized title of this asset entrylocale
- the locale of the language
-
setTitle
Sets the localized title of this asset entry in the language, and sets the default locale.- Parameters:
title
- the localized title of this asset entrylocale
- the locale of the languagedefaultLocale
- the default locale
-
setTitleCurrentLanguageId
-
setTitleMap
Sets the localized titles of this asset entry from the map of locales and localized titles.- Parameters:
titleMap
- the locales and localized titles of this asset entry
-
setTitleMap
Sets the localized titles of this asset entry from the map of locales and localized titles, and sets the default locale.- Parameters:
titleMap
- the locales and localized titles of this asset entrydefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this asset entry.- Returns:
- the description of this asset entry
-
getDescription
Returns the localized description of this asset entry 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 entry
-
getDescription
Returns the localized description of this asset entry 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 entry. 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 entry 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 entry
-
getDescription
Returns the localized description of this asset entry 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 entry
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this asset entry.- Returns:
- the locales and localized descriptions of this asset entry
-
setDescription
Sets the description of this asset entry.- Parameters:
description
- the description of this asset entry
-
setDescription
Sets the localized description of this asset entry in the language.- Parameters:
description
- the localized description of this asset entrylocale
- the locale of the language
-
setDescription
Sets the localized description of this asset entry in the language, and sets the default locale.- Parameters:
description
- the localized description of this asset entrylocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this asset entry from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this asset entry
-
setDescriptionMap
Sets the localized descriptions of this asset entry from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this asset entrydefaultLocale
- the default locale
-
getSummary
String getSummary()Returns the summary of this asset entry.- Returns:
- the summary of this asset entry
-
getSummary
Returns the localized summary of this asset entry 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 summary of this asset entry
-
getSummary
Returns the localized summary of this asset entry 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 summary of this asset entry. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getSummary
Returns the localized summary of this asset entry 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 summary of this asset entry
-
getSummary
Returns the localized summary of this asset entry 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 summary of this asset entry
-
getSummaryCurrentLanguageId
-
getSummaryCurrentValue
-
getSummaryMap
Returns a map of the locales and localized summaries of this asset entry.- Returns:
- the locales and localized summaries of this asset entry
-
setSummary
Sets the summary of this asset entry.- Parameters:
summary
- the summary of this asset entry
-
setSummary
Sets the localized summary of this asset entry in the language.- Parameters:
summary
- the localized summary of this asset entrylocale
- the locale of the language
-
setSummary
Sets the localized summary of this asset entry in the language, and sets the default locale.- Parameters:
summary
- the localized summary of this asset entrylocale
- the locale of the languagedefaultLocale
- the default locale
-
setSummaryCurrentLanguageId
-
setSummaryMap
Sets the localized summaries of this asset entry from the map of locales and localized summaries.- Parameters:
summaryMap
- the locales and localized summaries of this asset entry
-
setSummaryMap
Sets the localized summaries of this asset entry from the map of locales and localized summaries, and sets the default locale.- Parameters:
summaryMap
- the locales and localized summaries of this asset entrydefaultLocale
- the default locale
-
getUrl
Returns the url of this asset entry.- Returns:
- the url of this asset entry
-
setUrl
Sets the url of this asset entry.- Parameters:
url
- the url of this asset entry
-
getLayoutUuid
Returns the layout uuid of this asset entry.- Returns:
- the layout uuid of this asset entry
-
setLayoutUuid
Sets the layout uuid of this asset entry.- Parameters:
layoutUuid
- the layout uuid of this asset entry
-
getHeight
int getHeight()Returns the height of this asset entry.- Returns:
- the height of this asset entry
-
setHeight
void setHeight(int height) Sets the height of this asset entry.- Parameters:
height
- the height of this asset entry
-
getWidth
int getWidth()Returns the width of this asset entry.- Returns:
- the width of this asset entry
-
setWidth
void setWidth(int width) Sets the width of this asset entry.- Parameters:
width
- the width of this asset entry
-
getPriority
double getPriority()Returns the priority of this asset entry.- Returns:
- the priority of this asset entry
-
setPriority
void setPriority(double priority) Sets the priority of this asset entry.- Parameters:
priority
- the priority of this asset entry
-
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
AssetEntry cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfaceBaseModel<AssetEntry>
-
toXmlString
-