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 Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this asset entry.
      Specified by:
      getPrimaryKey in interface CTModel<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 interface CTModel<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 interface MVCCModel
      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 interface MVCCModel
      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 interface CTModel<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 interface CTModel<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 interface GroupedModel
      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 interface GroupedModel
      Parameters:
      groupId - the group ID of this asset entry
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this asset entry.
      Specified by:
      getCompanyId in interface AuditedModel
      Specified by:
      getCompanyId in interface ShardedModel
      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 interface AuditedModel
      Specified by:
      setCompanyId in interface ShardedModel
      Parameters:
      companyId - the company ID of this asset entry
    • getUserId

      long getUserId()
      Returns the user ID of this asset entry.
      Specified by:
      getUserId in interface AuditedModel
      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 interface AuditedModel
      Parameters:
      userId - the user ID of this asset entry
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this asset entry.
      Specified by:
      getUserUuid in interface AuditedModel
      Returns:
      the user uuid of this asset entry
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this asset entry.
      Specified by:
      setUserUuid in interface AuditedModel
      Parameters:
      userUuid - the user uuid of this asset entry
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this asset entry.
      Specified by:
      getUserName in interface AuditedModel
      Returns:
      the user name of this asset entry
    • setUserName

      void setUserName(String userName)
      Sets the user name of this asset entry.
      Specified by:
      setUserName in interface AuditedModel
      Parameters:
      userName - the user name of this asset entry
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this asset entry.
      Specified by:
      getCreateDate in interface AuditedModel
      Returns:
      the create date of this asset entry
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this asset entry.
      Specified by:
      setCreateDate in interface AuditedModel
      Parameters:
      createDate - the create date of this asset entry
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this asset entry.
      Specified by:
      getModifiedDate in interface AuditedModel
      Returns:
      the modified date of this asset entry
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this asset entry.
      Specified by:
      setModifiedDate in interface AuditedModel
      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 interface TypedModel
      Returns:
      the fully qualified class name of this asset entry
    • setClassName

      void setClassName(String className)
    • getClassNameId

      long getClassNameId()
      Returns the class name ID of this asset entry.
      Specified by:
      getClassNameId in interface TypedModel
      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 interface TypedModel
      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 interface AttachedModel
      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 interface AttachedModel
      Parameters:
      classPK - the class pk of this asset entry
    • getClassUuid

      @AutoEscape String getClassUuid()
      Returns the class uuid of this asset entry.
      Returns:
      the class uuid of this asset entry
    • setClassUuid

      void setClassUuid(String classUuid)
      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()
      Returns true 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()
      Returns true 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

      void setStartDate(Date startDate)
      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

      void setEndDate(Date endDate)
      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

      void setPublishDate(Date publishDate)
      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

      void setExpirationDate(Date expirationDate)
      Sets the expiration date of this asset entry.
      Parameters:
      expirationDate - the expiration date of this asset entry
    • getMimeType

      @AutoEscape String getMimeType()
      Returns the mime type of this asset entry.
      Returns:
      the mime type of this asset entry
    • setMimeType

      void setMimeType(String mimeType)
      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

      @AutoEscape String getTitle(Locale locale)
      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

      @AutoEscape String getTitle(Locale locale, boolean useDefault)
      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 language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this asset entry. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getTitle

      @AutoEscape String getTitle(String languageId)
      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

      @AutoEscape String getTitle(String languageId, boolean useDefault)
      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 language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized title of this asset entry
    • getTitleCurrentLanguageId

      @AutoEscape String getTitleCurrentLanguageId()
    • getTitleCurrentValue

      @AutoEscape String getTitleCurrentValue()
    • getTitleMap

      Map<Locale,String> 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

      void setTitle(String title)
      Sets the title of this asset entry.
      Parameters:
      title - the title of this asset entry
    • setTitle

      void setTitle(String title, Locale locale)
      Sets the localized title of this asset entry in the language.
      Parameters:
      title - the localized title of this asset entry
      locale - the locale of the language
    • setTitle

      void setTitle(String title, Locale locale, Locale defaultLocale)
      Sets the localized title of this asset entry in the language, and sets the default locale.
      Parameters:
      title - the localized title of this asset entry
      locale - the locale of the language
      defaultLocale - the default locale
    • setTitleCurrentLanguageId

      void setTitleCurrentLanguageId(String languageId)
    • setTitleMap

      void setTitleMap(Map<Locale,String> titleMap)
      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

      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.
      Parameters:
      titleMap - the locales and localized titles of this asset entry
      defaultLocale - the default locale
    • getDescription

      String getDescription()
      Returns the description of this asset entry.
      Returns:
      the description of this asset entry
    • getDescription

      @AutoEscape String getDescription(Locale locale)
      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

      @AutoEscape String 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.
      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 asset entry. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      @AutoEscape String getDescription(String languageId)
      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

      @AutoEscape String 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.
      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 asset entry
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> 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

      void setDescription(String description)
      Sets the description of this asset entry.
      Parameters:
      description - the description of this asset entry
    • setDescription

      void setDescription(String description, Locale locale)
      Sets the localized description of this asset entry in the language.
      Parameters:
      description - the localized description of this asset entry
      locale - the locale of the language
    • setDescription

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this asset entry in the language, and sets the default locale.
      Parameters:
      description - the localized description of this asset entry
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      void setDescriptionCurrentLanguageId(String languageId)
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap)
      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

      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.
      Parameters:
      descriptionMap - the locales and localized descriptions of this asset entry
      defaultLocale - the default locale
    • getSummary

      String getSummary()
      Returns the summary of this asset entry.
      Returns:
      the summary of this asset entry
    • getSummary

      @AutoEscape String getSummary(Locale locale)
      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

      @AutoEscape String 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.
      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 summary of this asset entry. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getSummary

      @AutoEscape String getSummary(String languageId)
      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

      @AutoEscape String 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.
      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 summary of this asset entry
    • getSummaryCurrentLanguageId

      @AutoEscape String getSummaryCurrentLanguageId()
    • getSummaryCurrentValue

      @AutoEscape String getSummaryCurrentValue()
    • getSummaryMap

      Map<Locale,String> 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

      void setSummary(String summary)
      Sets the summary of this asset entry.
      Parameters:
      summary - the summary of this asset entry
    • setSummary

      void setSummary(String summary, Locale locale)
      Sets the localized summary of this asset entry in the language.
      Parameters:
      summary - the localized summary of this asset entry
      locale - the locale of the language
    • setSummary

      void setSummary(String summary, Locale locale, Locale defaultLocale)
      Sets the localized summary of this asset entry in the language, and sets the default locale.
      Parameters:
      summary - the localized summary of this asset entry
      locale - the locale of the language
      defaultLocale - the default locale
    • setSummaryCurrentLanguageId

      void setSummaryCurrentLanguageId(String languageId)
    • setSummaryMap

      void setSummaryMap(Map<Locale,String> summaryMap)
      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

      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.
      Parameters:
      summaryMap - the locales and localized summaries of this asset entry
      defaultLocale - the default locale
    • getUrl

      Returns the url of this asset entry.
      Returns:
      the url of this asset entry
    • setUrl

      void setUrl(String url)
      Sets the url of this asset entry.
      Parameters:
      url - the url of this asset entry
    • getLayoutUuid

      @AutoEscape String getLayoutUuid()
      Returns the layout uuid of this asset entry.
      Returns:
      the layout uuid of this asset entry
    • setLayoutUuid

      void setLayoutUuid(String layoutUuid)
      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 interface LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • cloneWithOriginalValues

      AssetEntry cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<AssetEntry>
    • toXmlString

      default String toXmlString()