Interface CalendarModel

All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<Calendar>, com.liferay.portal.kernel.model.ClassedModel, Cloneable, Comparable<Calendar>, com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel
All Known Subinterfaces:
Calendar
All Known Implementing Classes:
CalendarWrapper

@ProviderType public interface CalendarModel extends com.liferay.portal.kernel.model.BaseModel<Calendar>, com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
The base model interface for the Calendar service. Represents a row in the "Calendar" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation com.liferay.calendar.model.impl.CalendarModelImpl 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.calendar.model.impl.CalendarImpl.

See Also:
Generated:
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this calendar.
      Specified by:
      getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
      Returns:
      the primary key of this calendar
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this calendar.
      Specified by:
      setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
      Parameters:
      primaryKey - the primary key of this calendar
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this calendar.
      Specified by:
      getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Returns:
      the mvcc version of this calendar
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this calendar.
      Specified by:
      setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this calendar
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this calendar.
      Specified by:
      getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
      Returns:
      the ct collection ID of this calendar
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this calendar.
      Specified by:
      setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
      Parameters:
      ctCollectionId - the ct collection ID of this calendar
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this calendar.
      Specified by:
      getUuid in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the uuid of this calendar
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this calendar.
      Specified by:
      setUuid in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      uuid - the uuid of this calendar
    • getCalendarId

      long getCalendarId()
      Returns the calendar ID of this calendar.
      Returns:
      the calendar ID of this calendar
    • setCalendarId

      void setCalendarId(long calendarId)
      Sets the calendar ID of this calendar.
      Parameters:
      calendarId - the calendar ID of this calendar
    • getGroupId

      long getGroupId()
      Returns the group ID of this calendar.
      Specified by:
      getGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Returns:
      the group ID of this calendar
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this calendar.
      Specified by:
      setGroupId in interface com.liferay.portal.kernel.model.GroupedModel
      Parameters:
      groupId - the group ID of this calendar
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this calendar.
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      getCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the company ID of this calendar
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this calendar.
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel
      Specified by:
      setCompanyId in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      companyId - the company ID of this calendar
    • getUserId

      long getUserId()
      Returns the user ID of this calendar.
      Specified by:
      getUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user ID of this calendar
    • setUserId

      void setUserId(long userId)
      Sets the user ID of this calendar.
      Specified by:
      setUserId in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userId - the user ID of this calendar
    • getUserUuid

      String getUserUuid()
      Returns the user uuid of this calendar.
      Specified by:
      getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user uuid of this calendar
    • setUserUuid

      void setUserUuid(String userUuid)
      Sets the user uuid of this calendar.
      Specified by:
      setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userUuid - the user uuid of this calendar
    • getUserName

      @AutoEscape String getUserName()
      Returns the user name of this calendar.
      Specified by:
      getUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Returns:
      the user name of this calendar
    • setUserName

      void setUserName(String userName)
      Sets the user name of this calendar.
      Specified by:
      setUserName in interface com.liferay.portal.kernel.model.AuditedModel
      Parameters:
      userName - the user name of this calendar
    • getCreateDate

      Date getCreateDate()
      Returns the create date of this calendar.
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the create date of this calendar
    • setCreateDate

      void setCreateDate(Date createDate)
      Sets the create date of this calendar.
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setCreateDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      createDate - the create date of this calendar
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this calendar.
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Returns:
      the modified date of this calendar
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this calendar.
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel
      Specified by:
      setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel
      Parameters:
      modifiedDate - the modified date of this calendar
    • getCalendarResourceId

      long getCalendarResourceId()
      Returns the calendar resource ID of this calendar.
      Returns:
      the calendar resource ID of this calendar
    • setCalendarResourceId

      void setCalendarResourceId(long calendarResourceId)
      Sets the calendar resource ID of this calendar.
      Parameters:
      calendarResourceId - the calendar resource ID of this calendar
    • getName

      String getName()
      Returns the name of this calendar.
      Returns:
      the name of this calendar
    • getName

      @AutoEscape String getName(Locale locale)
      Returns the localized name of this calendar 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 name of this calendar
    • getName

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this calendar 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 name of this calendar. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getName

      @AutoEscape String getName(String languageId)
      Returns the localized name of this calendar 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 name of this calendar
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this calendar 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 name of this calendar
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this calendar.
      Returns:
      the locales and localized names of this calendar
    • setName

      void setName(String name)
      Sets the name of this calendar.
      Parameters:
      name - the name of this calendar
    • setName

      void setName(String name, Locale locale)
      Sets the localized name of this calendar in the language.
      Parameters:
      name - the localized name of this calendar
      locale - the locale of the language
    • setName

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this calendar in the language, and sets the default locale.
      Parameters:
      name - the localized name of this calendar
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      void setNameCurrentLanguageId(String languageId)
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap)
      Sets the localized names of this calendar from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this calendar
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
      Sets the localized names of this calendar from the map of locales and localized names, and sets the default locale.
      Parameters:
      nameMap - the locales and localized names of this calendar
      defaultLocale - the default locale
    • getDescription

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

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this calendar 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 calendar
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this calendar 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 calendar. 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 calendar 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 calendar
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this calendar 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 calendar
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this calendar.
      Returns:
      the locales and localized descriptions of this calendar
    • setDescription

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

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

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this calendar in the language, and sets the default locale.
      Parameters:
      description - the localized description of this calendar
      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 calendar from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this calendar
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
      Sets the localized descriptions of this calendar from the map of locales and localized descriptions, and sets the default locale.
      Parameters:
      descriptionMap - the locales and localized descriptions of this calendar
      defaultLocale - the default locale
    • getTimeZoneId

      @AutoEscape String getTimeZoneId()
      Returns the time zone ID of this calendar.
      Returns:
      the time zone ID of this calendar
    • setTimeZoneId

      void setTimeZoneId(String timeZoneId)
      Sets the time zone ID of this calendar.
      Parameters:
      timeZoneId - the time zone ID of this calendar
    • getColor

      int getColor()
      Returns the color of this calendar.
      Returns:
      the color of this calendar
    • setColor

      void setColor(int color)
      Sets the color of this calendar.
      Parameters:
      color - the color of this calendar
    • getDefaultCalendar

      boolean getDefaultCalendar()
      Returns the default calendar of this calendar.
      Returns:
      the default calendar of this calendar
    • isDefaultCalendar

      boolean isDefaultCalendar()
      Returns true if this calendar is default calendar.
      Returns:
      true if this calendar is default calendar; false otherwise
    • setDefaultCalendar

      void setDefaultCalendar(boolean defaultCalendar)
      Sets whether this calendar is default calendar.
      Parameters:
      defaultCalendar - the default calendar of this calendar
    • getEnableComments

      boolean getEnableComments()
      Returns the enable comments of this calendar.
      Returns:
      the enable comments of this calendar
    • isEnableComments

      boolean isEnableComments()
      Returns true if this calendar is enable comments.
      Returns:
      true if this calendar is enable comments; false otherwise
    • setEnableComments

      void setEnableComments(boolean enableComments)
      Sets whether this calendar is enable comments.
      Parameters:
      enableComments - the enable comments of this calendar
    • getEnableRatings

      boolean getEnableRatings()
      Returns the enable ratings of this calendar.
      Returns:
      the enable ratings of this calendar
    • isEnableRatings

      boolean isEnableRatings()
      Returns true if this calendar is enable ratings.
      Returns:
      true if this calendar is enable ratings; false otherwise
    • setEnableRatings

      void setEnableRatings(boolean enableRatings)
      Sets whether this calendar is enable ratings.
      Parameters:
      enableRatings - the enable ratings of this calendar
    • getLastPublishDate

      Date getLastPublishDate()
      Returns the last publish date of this calendar.
      Specified by:
      getLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Returns:
      the last publish date of this calendar
    • setLastPublishDate

      void setLastPublishDate(Date lastPublishDate)
      Sets the last publish date of this calendar.
      Specified by:
      setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel
      Parameters:
      lastPublishDate - the last publish date of this calendar
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel
      Throws:
      com.liferay.portal.kernel.exception.LocaleException
    • cloneWithOriginalValues

      Calendar cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface com.liferay.portal.kernel.model.BaseModel<Calendar>
    • toXmlString

      default String toXmlString()